Commit Graph

31 Commits

Author SHA1 Message Date
Martin Panter 4ed35fc4f3 Issue #25161: Add full stops in documentation; patch by Takase Arihiro 2015-10-10 10:52:35 +00:00
Benjamin Peterson 29368584d2 clarify behavior of shutil.move when destination exists (closes #22933)
Patch by Mike Short.
2015-03-22 10:11:54 -04:00
Andrew Svetlov 1625d88709 Issue #16341: convert examples to use except ... as ... syntax. 2012-10-30 21:56:43 +02:00
Hynek Schlawack e58ce01f30 #14804: Remove [] around optional arguments with default values
Mostly just mechanical removal of []. In some rare cases I've pulled the
default value up into the argument list.
2012-05-22 10:27:40 +02:00
Éric Araujo c446ce78b8 Document that shutil.make_archive does not typecheck its logger argument 2012-02-26 01:33:49 +01:00
Éric Araujo c3cc2acb09 Improve interlinking of archiving/compression modules docs.
- Remove duplicate list of links to the other modules from each
  module’s doc (people can already go up to library/archiving and
  there they can see the list).

- Link to shutil high-level operations.

Reviewed by Nadeem Vawda in #6715.
2012-02-26 01:10:14 +01:00
Senthil Kumaran ef18737b7f shutil copy module reference doc fix. 2012-02-13 23:17:45 +08:00
Éric Araujo 99c4c340e6 Add missing documentation for logger argument of shutil.make_archive 2011-08-19 02:51:17 +02:00
Éric Araujo 29a0b57e4e Backport source links from 3.x.
Existing links have been updated to use the new reST role.  In some
files, I have also made cosmetic changes to the header.
2011-08-19 02:14:03 +02:00
Senthil Kumaran 22a7b488e0 Fix closes Issue12183 - Explain the Symlink copy behavior in shutil.copytree. Patch by Petri Lehtinen. 2011-08-02 18:50:44 +08:00
Éric Araujo d01aebe3d6 Update documentation for shutil.move (#12043) and fix a few typos.
Adding Sandro Tosi to Doc/ACKS for this patch and all his work on the
docs mailing list and on the bug tracker.
2011-07-29 12:10:53 +02:00
Senthil Kumaran 60bf489e8a merge from 3.2 - Fix closes issue12577 - clarify shutil.move documentation. Patch suggestion by Catalin Iacob 2011-07-19 08:05:44 +08:00
Raymond Hettinger e0e082281e Add more links to Python sources where the code is short, readable and an informative adjunct to the docs. 2010-11-06 07:10:31 +00:00
Tarek Ziadé e593fad81b removed ztar support in shutil.make_archive 2010-04-20 21:09:06 +00:00
Tarek Ziadé 8a12f940fe Fixed #8463: added missing reference to bztar in shutil's documentation. 2010-04-19 21:28:21 +00:00
Tarek Ziadé 48cc8dc958 added make_archive (and secondary APIs) to shutil 2010-02-23 05:16:41 +00:00
Georg Brandl c1edec3374 Use the preferred form of raise statements in the docs. 2009-06-03 07:25:35 +00:00
Georg Brandl c62ef8b4d9 Remove trailing whitespace. 2009-01-03 20:55:06 +00:00
Benjamin Peterson d729aada6a specify how things are copied 2008-12-09 02:03:03 +00:00
Georg Brandl 905e0f65ba #4478: document that copyfile() can raise Error. 2008-12-05 15:32:29 +00:00
Georg Brandl 9af9498c6e Remove things specific to the old Macintosh, and spell "Mac OS X" consistently. 2008-09-13 17:41:16 +00:00
Andrew M. Kuchling c40608491c Wording fix 2008-07-06 17:43:16 +00:00
Georg Brandl e78fbcce3e #2663: support an *ignore* argument to shutil.copytree(). Patch by Tarek Ziade.
This is a new feature, but Barry authorized adding it in the beta period.
2008-07-05 10:13:36 +00:00
Georg Brandl 88107dafef #2845: fix copy2's docs. 2008-05-16 13:18:50 +00:00
Georg Brandl 786ead684a #2369: clarify that copyfile() doesn't take a target directory. 2008-04-19 16:57:43 +00:00
Georg Brandl 5235398323 #1669: don't allow shutil.rmtree() to be called on a symlink. 2008-01-20 14:17:42 +00:00
Georg Brandl ec32b6bce7 #1559684: document that shutil.copy* doesn't copy all metadata on Posix and Windows too. 2008-01-06 16:12:39 +00:00
Georg Brandl b19be571e0 Some cleanup in the docs. 2007-12-29 10:57:00 +00:00
Mark Summerfield ac3d429edc Added more file-handling related cross-references. 2007-11-02 08:24:59 +00:00
Georg Brandl bf863b17f0 Replace "Caveat" paragraphs by .. warning::s. 2007-08-15 19:06:04 +00:00
Georg Brandl 8ec7f65613 Move the 2.6 reST doc tree in place. 2007-08-15 14:28:01 +00:00