d5489a964f
bpo-22021: Update root_dir and base_dir documentation in shutil (GH-10367)
...
Also added an example in shutil in order to make more clear how they are to be used.
Initially reported by Weinan Li on bpo.
(cherry picked from commit 7633371dac
2020-06-07 22:07:06 -07:00
861f61b5a9
[3.7] bpo-34260, shutil: fix copy2 and copystat documentation (GH-8523) (GH-10065)
...
Fix the documentation of copy2, as it does not copy file ownership (user and
group), only mode, mtime, atime and flags.
The original text was confusing to developers as it suggested that this
command is the same as 'cp -p', but according to cp(1), '-p' copies file
ownership as well.
Clarify which metadata is copied by shutil.copystat in its docstring.
(cherry picked from commit 4f399be0e7
2018-10-23 23:57:55 +02:00
b248a8c9a5
[3.7] bpo-11233: Create availability directive for documentation (GH-9692) (GH-9830)
...
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
Original patch by Georg Brandl.
Co-Authored-By: Georg Brandl <georg@python.org>
(cherry picked from commit 2d6097d027
2018-10-15 22:52:26 +02:00
ee3b83547c
bpo-26330: Update shutil.disk_usage() documentation (GH-5184)
...
Clarify that on Windows, path must be a directory.
On Unix, path can be a file or a directory.
2018-01-14 21:08:37 -08:00
a12df7b7d4
bpo-30218: support path-like objects in shutil.unpack_archive() (GH-1367)
...
Thanks to Jelle Zijlstra for the patch.
2017-05-05 14:27:12 -07:00
70ee0cd5c2
bpo-29784: Fix the reference to shutil.copy in the docs (GH-602)
2017-03-10 18:17:21 -08:00
fe607beef7
Merge from 3.5
2016-12-27 15:09:35 +03:00
8e2bdc8fe8
Move versionadded inside of the get_terminal_size() block
2016-12-27 15:09:11 +03:00
fff07e34fa
Merge spelling and grammar from 3.5
2016-12-18 05:37:21 +00:00
2f9171d900
Fix spelling and grammar in code comments and documentation
2016-12-18 01:23:09 +00:00
9bb6fe5274
Issue #14061 : Misc fixes and cleanups in archiving code in shutil.
...
Imporoved the documentation and tests for make_archive() and unpack_archive().
Improved error handling when corresponding compress module is not available.
Brake circular dependency between shutil and tarfile modules.
2016-12-16 19:00:55 +02:00
20cdffd830
Issue #14061 : Misc fixes and cleanups in archiving code in shutil.
...
Imporoved the documentation and tests for make_archive() and unpack_archive().
Improved error handling when corresponding compress module is not available.
Brake circular dependency between shutil and tarfile modules.
2016-12-16 18:58:33 +02:00
99b6f28351
Merge doc fixups from 3.5
2016-11-21 04:22:22 +00:00
357ed2e577
Change double hyphens (en dashes) to em (longer) dashes
2016-11-21 00:15:20 +00:00
dd917f84e3
Closes #27904 : Improved logging statements to defer formatting until needed.
2016-08-31 08:22:29 +01:00
1050d2d0c7
Issue #26462 : Doc: reduce literal_block warnings, fix syntax highlighting.
...
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
fa089b9b0b
Issue #22558 : Add remaining doc links to source code for Python-coded modules.
...
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
6a7b3a77b4
Issue #26778 : Fixed "a/an/and" typos in code comment and documentation.
2016-04-17 08:32:47 +03:00
2eb819f7a8
Issue #25523 : Merge "a" to "an" fixes from 3.4 into 3.5
2015-11-02 04:04:57 +00:00
7462b64911
Issue #25523 : Correct "a" article to "an" article
...
This changes the main documentation, doc strings, source code comments, and a
couple error messages in the test suite. In some cases the word was removed
or edited some other way to fix the grammar.
2015-11-02 03:37:02 +00:00
84835ab1cb
Issue #25161 : Merge full stops from 3.4 into 3.5
2015-10-10 10:44:25 +00:00
d21e0b52f1
Issue #25161 : Add full stops in documentation; patch by Takase Arihiro
2015-10-10 10:36:22 +00:00
b4760efbad
Back porting changeset db302b88fdb6 to 3.4 branch, which fixed multiple documentation typos.
...
Related Issues:
#issue21528
#issue24453
2015-06-14 17:35:37 -07:00
67057ab57c
merge 3.4 ( #22933 )
2015-03-22 10:15:12 -04:00
218144a94d
clarify behavior of shutil.move when destination exists ( closes #22933 )
...
Patch by Mike Short.
2015-03-22 10:11:54 -04:00
455de40a6e
merge with 3.4
2014-10-31 10:54:10 +01:00
36ac510956
Closes #22771 : "verbose" is unused; deprecate it.
2014-10-31 10:54:06 +01:00
e21a531ef1
merge with 3.4
2014-10-31 10:39:29 +01:00
9b1b0e54e7
#22613 : elaborate on arguments of shutil archival functions (thanks Jacques Ducasse)
2014-10-31 10:02:40 +01:00
ae04ba1952
Fix usage of the versionchanged directive.
...
Patch by Akira Li.
2014-08-11 18:10:25 +03:00
f3440c6881
Issue #5411 : Fixed version number.
2014-08-06 18:55:54 +03:00
1121377cdb
Issue #5411 : Added support for the "xztar" format in the shutil module.
2014-08-06 18:50:19 +03:00
6ffface429
#19840 : Add copy_function to shutil.move.
...
Patch by Claudiu Popa.
2014-06-11 14:40:13 -04:00
8b852f111e
Fix Issue #21528 - Fix documentation typos
2014-05-20 12:58:38 -04:00
ba74885e0c
Issue19643 Fix whitespace
2014-05-07 18:08:08 +01:00
783377998a
Issue19643 Add an example of shutil.rmtree which shows how to cope with readonly files on Windows
2014-05-07 18:05:45 +01:00
1d006a2c0e
Backout a1a05e2724dd: shutil.which(bytes) is a new feature and my patch does not work on Windows
2013-12-16 23:39:40 +01:00
fffb96ba66
Issue #18283 : shutil.which() now supports bytes argument, not only text argument.
2013-12-16 22:48:48 +01:00
2ba095c6c5
Fix shutil.which() test for issue #16993 .
2013-01-22 10:32:16 +02:00
80c88f4304
Fix shutil.which() test for issue #16993 .
2013-01-22 10:31:36 +02:00
5b987c2e68
Issue #16993 : shutil.which() now preserves the case of the path and extension
...
on Windows.
2013-01-21 15:01:34 +02:00
014791f848
Issue #16993 : shutil.which() now preserves the case of the path and extension
...
on Windows.
2013-01-21 15:00:27 +02:00
2606a6f197
Issue #16719 : Get rid of WindowsError. Use OSError instead
...
Patch by Serhiy Storchaka.
2012-12-19 14:33:35 +02:00
88a3e1f46b
Merge: use OSError instead of os.error in the docs.
2012-12-15 22:59:55 +02:00
618c2e13ca
Use OSError instead of os.error in the docs.
2012-12-15 22:59:24 +02:00
27ddb576f1
#1492704 : Ensure and document backward compatibility of the change
2012-10-28 13:59:27 +01:00
4865376c44
Closes #1492704 : Make shutil.copyfile() raise a distinct SameFileError
...
Patch by Atsuo Ishimoto.
2012-10-07 12:49:58 +02:00
60eba57f3e
Cleanup/rewrite shutil docs regarding follow_symlinks and copying attributes.
2012-09-21 10:12:14 -07:00
26fe37dd3f
#1492704 : Backout and wait for 3.4
2012-07-19 21:41:02 +02:00
77d3283370
#1492704 : Make shutil.copyfile() raise a distinct SameFileError
...
Patch by Atsuo Ishimoto.
2012-07-19 20:23:49 +02:00
Miss Islington (bot)
Zsolt Cserna
Cheryl Sabella
Jelle Zijlstra
Mariatta
Berker Peksag
Martin Panter
Serhiy Storchaka
Vinay Sajip
Terry Jan Reedy
Senthil Kumaran
Benjamin Peterson
Georg Brandl
R David Murray
Donald Stufft
Tim Golden
Victor Stinner
Andrew Svetlov
Hynek Schlawack
Larry Hastings