bpo-29341: Added path.like object to docstring in posixmodule.c and posixmodule.c.h#10101
Merged
Conversation
Contributor
Author
|
All changes on the docstring have been verified and tested, and these |
pablogsal
reviewed
Oct 29, 2018
| @@ -0,0 +1 @@ | |||
| Added path-like objects to docstrings of os methods that accept path | |||
Member
There was a problem hiding this comment.
I find this a bit confusing. I would rewrite so it says:
Clarify in the docstrings of :mod:`os` methods that path-like objects are also accepted
as input parameters.
pablogsal
reviewed
Oct 29, 2018
|
|
||
| path: path_t | ||
| Path to be tested; can be string or bytes | ||
| Path to be tested; can be string, bytes, or path-like object |
Member
There was a problem hiding this comment.
I think this needs an "a": or **a** path-like object? (The same for the rest of the methods)
Contributor
Author
|
@pablogsal Thanks so much for the review. I have made the changes suggested now! 👍 |
pablogsal
reviewed
Nov 2, 2018
| os.access -> bool | ||
|
|
||
| path: path_t | ||
| Path to be tested; can be string or bytes |
Member
There was a problem hiding this comment.
Could you add a . at the end of this sentence? :)
Path to be tested; can be string, bytes, or a path-like object.
pablogsal
reviewed
Nov 2, 2018
Co-Authored-By: BNMetrics <luna@bnmetrics.com>
pablogsal
approved these changes
Nov 2, 2018
pablogsal
left a comment
Member
There was a problem hiding this comment.
Thank you very much @BNMetrics for the PR and for the patience going through the review! 🎉
LGTM
Contributor
Author
|
Thank you so much @pablogsal ! |
Contributor
|
Thanks @BNMetrics for the PR, and @pablogsal for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6. |
Contributor
|
Thanks @BNMetrics for the PR, and @pablogsal for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7. |
Contributor
|
Sorry, @BNMetrics and @pablogsal, I could not cleanly backport this to |
Contributor
|
Sorry, @BNMetrics and @pablogsal, I could not cleanly backport this to |
Member
|
Yup, I think it was a bit naive to think that the automatic backport will work. This is because the clinic file needs to be correctly regenerated after the patch is applied (which can have some conflicts as well). @BNMetrics Do you want to do the manual backport PRs? If you don't want to I can do them myself :) |
BNMetrics
added a commit
to BNMetrics/cpython
that referenced
this pull request
Nov 2, 2018
…os methods (pythonGH-10101) Some methods in the os module can accept path-like objects. This is documented in the general documentation but not in the function docstrings. To keep both in sync, the docstrings need to be updated to reflect that path-like objects are also accepted.. (cherry picked from commit b942707) Co-authored-by: BNMetrics <luna@bnmetrics.com>
|
BNMetrics
added a commit
to BNMetrics/cpython
that referenced
this pull request
Nov 2, 2018
…os methods (pythonGH-10101) Some methods in the os module can accept path-like objects. This is documented in the general documentation but not in the function docstrings. To keep both in sync, the docstrings need to be updated to reflect that path-like objects are also accepted.. (cherry picked from commit b942707) Co-authored-by: BNMetrics <luna@bnmetrics.com>
Member
|
Ignore that, is an unrelated failure |
pablogsal
pushed a commit
to pablogsal/cpython
that referenced
this pull request
Nov 2, 2018
…os methods (pythonGH-10101) Some methods in the os module can accept path-like objects. This is documented in the general documentation but not in the function docstrings. To keep both in sync, the docstrings need to be updated to reflect that path-like objects are also accepted.. (cherry picked from commit b942707) Co-authored-by: BNMetrics <luna@bnmetrics.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
https://bugs.python.org/issue29341