Commit Graph

74 Commits

Author SHA1 Message Date
Miss Islington (bot) da86bf7396
Changes to the documentation of normcase (GH-4725)
(cherry picked from commit 32d1458b2e)

Co-authored-by: Kexuan Sun <me@kianasun.com>
2019-05-13 19:21:25 -07:00
Miss Islington (bot) a4aade2cf8
bpo-29707: Document that os.path.ismount() is not able to reliable detect bind mounts. (GH-11238)
(cherry picked from commit 32ebd8508d)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2019-01-15 01:01:15 -08:00
Miss Islington (bot) fdf48b6b88 bpo-35054: Add yet more index entries for symbols. (GH-10121) (GH-10171)
(cherry picked from commit 913876d824)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-10-28 18:43:32 +02:00
Miss Islington (bot) ec10b70ea6
bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)
(cherry picked from commit e483f02423)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-26 03:56:28 -07:00
Serhiy Storchaka 9a75b8470a
[3.7] bpo-35054: Add more index entries for symbols. (GH-10064). (GH-10120)
(cherry picked from commit ddb961d2ab)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-10-26 11:18:42 +03:00
Cheryl Sabella 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)

 Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-10-15 22:52:26 +02:00
Cheryl Sabella b3dd18d403 bpo-15221: Update os.path.is*() documentation (GH-5185)
`os.path.is*()` can return False if the file can't be accessed.
The behaviour is documented in details in `os.path.exists()`.
Link to `os.path.exists()` from `os.path.is*()`.
2018-01-14 20:57:51 -08:00
Victor Stinner 01b5aab7bf bpo-31827: Remove os.stat_float_times() (GH-4061) 2017-10-24 02:02:00 -07:00
Serhiy Storchaka 9ed707eb4c Issue #29197: Removed deprecated function ntpath.splitunc(). 2017-01-13 20:55:05 +02:00
Brett Cannon 6fa7aada9b Issue #26027, #27524: Document the support for path-like objects in os and os.path.
This completes PEP 519.
2016-09-06 15:55:02 -07:00
Terry Jan Reedy 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
Ned Deily 32db43867c Issue 27216: Fix typo (noticed by Alex Chan). 2016-06-04 09:40:40 -07:00
Martin Panter 2eb819f7a8 Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5 2015-11-02 04:04:57 +00:00
Martin Panter 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
Yury Selivanov de11561862 Further improve os.path.commonprefix() docs.
Patch by Serhiy Storchaka.
2015-08-19 09:53:28 -04:00
Yury Selivanov 80ac11f95f docs: Improve docs for os.path.commonprefix 2015-08-17 23:43:43 -04:00
Serhiy Storchaka 3822093143 Issue #10395: Added os.path.commonpath(). Implemented in posixpath and ntpath.
Based on patch by Rafik Draoui.
2015-03-31 15:31:53 +03:00
Zachary Ware a13dab47cb Issue #15414: Clean and correct the os.path.join docs.
In particular, correctly describe the behavior of ntpath.join.

Based on a patch by Dave Sawyer.
2014-10-10 16:03:14 -05:00
Benjamin Peterson f6f78e1d9d clarify that islink only really works if python knows about symlinks (closes #13143)
Patch from Yayoi Ukai.
2014-06-22 17:59:35 -07:00
Benjamin Peterson 409a1be6cf improve start default for relpath 2014-03-20 12:39:53 -05:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Serhiy Storchaka 0e90e99188 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:19:53 +02:00
Serhiy Storchaka fbc1c26803 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:17:13 +02:00
Antoine Pitrou 31119e4f10 Issue #19673: Add pathlib to the stdlib as a provisional module (PEP 428). 2013-11-22 17:38:12 +01:00
Serhiy Storchaka 690a6a95bd Issue #19207: Improved cross-references in the os, os.path, and posix modules
documentation.
2013-10-13 20:13:37 +03:00
Serhiy Storchaka dab8354920 Issue #19207: Improved cross-references in the os, os.path, and posix modules
documentation.
2013-10-13 20:12:43 +03:00
Georg Brandl 1cb28a1be8 merge with 3.3 2013-10-06 09:53:11 +02:00
Georg Brandl f6324941f0 Clarify docs for os.path.getctime on Unix: it is the inode (metadata) change time 2013-10-06 09:52:55 +02:00
R David Murray d0a03ad139 #18389: Clarify that relpath does not access the file system.
Initial patch by Madison May.
2013-07-12 17:43:53 -04:00
R David Murray ce10fab9f6 #18389: Clarify that relpath does not access the file system.
Initial patch by Madison May.
2013-07-12 17:43:11 -04:00
Terry Jan Reedy 15cddb498e Merge with 3.3 2013-03-17 15:29:19 -04:00
Terry Jan Reedy b271727bad Merge with 3.2 2013-03-17 15:28:52 -04:00
Terry Jan Reedy f3460414d5 Issue #17415: Trim trailing whitespace 2013-03-17 15:28:10 -04:00
Terry Jan Reedy a52c2d6d2f Merge with 3.3 2013-03-17 15:25:12 -04:00
Terry Jan Reedy 3380170ea5 Merge with 3.2 2013-03-17 15:22:00 -04:00
Terry Jan Reedy ec6e132987 Issue #17415: Clarify 'this' referent by moving containing sentence just after
the sentence referred to. Make other minor edits to improve flow.
2013-03-17 15:21:26 -04:00
R David Murray 4e62033b57 merge #16877: Add mention that shell-style path expansions are not automatic. 2013-01-06 16:14:22 -05:00
R David Murray e6dec98e45 merge #16877: Add mention that shell-style path expansions are not automatic. 2013-01-06 16:13:51 -05:00
R David Murray a4e700c040 #16877: Add mention that shell-style path expansions are not automatic. 2013-01-06 16:13:10 -05:00
Brian Curtin 490b32a397 Fix #11939. Set st_dev attribute on Windows to simplify os.path.samefile.
By setting the st_dev attribute, we can then remove some Windows-specific
code and move os.path.samefile/sameopenfile/samestat to Lib/genericpath.py
so all platforms share the same implementation.
2012-12-26 07:03:03 -06:00
Andrew Svetlov 88a3e1f46b Merge: use OSError instead of os.error in the docs. 2012-12-15 22:59:55 +02:00
Andrew Svetlov 618c2e13ca Use OSError instead of os.error in the docs. 2012-12-15 22:59:24 +02:00
Chris Jerdonek b48f4ea601 Merge from 3.3: add hyperlinks to some os.path function docs (issue #16552). 2012-11-25 20:42:00 -08:00
Chris Jerdonek 3b39d35eeb Merge from 3.2: add hyperlinks to some os.path function docs (issue #16552). 2012-11-25 20:40:57 -08:00
Chris Jerdonek 0b502ff33b Add hyperlinks to the docs of some os.path functions (issue #16552). 2012-11-25 20:38:01 -08:00
Jesus Cea f6c2e894ae #16135: Removal of OS/2 support (Docs) 2012-10-05 01:11:10 +02:00
Richard Oudkerk 2240ac1eae Issue #15261: Stop os.stat(fd) crashing on Windows when fd not open. 2012-07-06 12:05:32 +01:00
Georg Brandl 61063cca6a Fix a couple of versionadded/versionchanged related markup errors. 2012-06-24 22:48:30 +02:00
R David Murray 24eb4bc5c9 #9921: clarify os.path.join joining algorithm
The new wording is based on the comments in the code, which
match the actual behavior.
2011-06-23 21:26:13 -04:00
Antoine Pitrou f10f162db9 Consistent ordering of availability statements 2010-12-12 20:17:29 +00:00