Skip to content

bpo-38422: Clarify docstrings of pathlib suffix(es) #16679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 2, 2019

Conversation

cool-RR
Copy link
Contributor

@cool-RR cool-RR commented Oct 9, 2019

Whenever I use path.suffix I have to check again whether it includes the dot or not. I decided to add it to the docstring so I won't have to keep checking.

https://bugs.python.org/issue38422

Automerge-Triggered-By: @pitrou

@cool-RR cool-RR marked this pull request as ready for review October 9, 2019 15:24
@brandtbucher brandtbucher added the docs Documentation in the Doc dir label Oct 9, 2019
Copy link
Member

@brandtbucher brandtbucher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, thanks for this improvement @cool-RR!

@cool-RR
Copy link
Contributor Author

cool-RR commented Oct 30, 2019

@pitrou Would you like to review this PR?

Copy link
Member

@pitrou pitrou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An obvious improvement. Thanks @cool-RR for doing this.

@miss-islington miss-islington merged commit 8d4fef4 into python:master Nov 2, 2019
@miss-islington
Copy link
Contributor

Thanks @cool-RR for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-17031 is a backport of this pull request to the 3.8 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 2, 2019
Whenever I use `path.suffix` I have to check again whether it includes the dot or not. I decided to add it to the docstring so I won't have to keep checking.

https://bugs.python.org/issue38422

Automerge-Triggered-By: @pitrou
(cherry picked from commit 8d4fef4)

Co-authored-by: Ram Rachum <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 2, 2019
Whenever I use `path.suffix` I have to check again whether it includes the dot or not. I decided to add it to the docstring so I won't have to keep checking.

https://bugs.python.org/issue38422

Automerge-Triggered-By: @pitrou
(cherry picked from commit 8d4fef4)

Co-authored-by: Ram Rachum <[email protected]>
@bedevere-bot
Copy link

GH-17032 is a backport of this pull request to the 3.7 branch.

miss-islington added a commit that referenced this pull request Nov 2, 2019
Whenever I use `path.suffix` I have to check again whether it includes the dot or not. I decided to add it to the docstring so I won't have to keep checking.

https://bugs.python.org/issue38422

Automerge-Triggered-By: @pitrou
(cherry picked from commit 8d4fef4)

Co-authored-by: Ram Rachum <[email protected]>
miss-islington added a commit that referenced this pull request Nov 2, 2019
Whenever I use `path.suffix` I have to check again whether it includes the dot or not. I decided to add it to the docstring so I won't have to keep checking.

https://bugs.python.org/issue38422

Automerge-Triggered-By: @pitrou
(cherry picked from commit 8d4fef4)

Co-authored-by: Ram Rachum <[email protected]>
jacobneiltaylor pushed a commit to jacobneiltaylor/cpython that referenced this pull request Dec 5, 2019
Whenever I use `path.suffix` I have to check again whether it includes the dot or not. I decided to add it to the docstring so I won't have to keep checking. 


https://bugs.python.org/issue38422



Automerge-Triggered-By: @pitrou
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Jan 31, 2020
Whenever I use `path.suffix` I have to check again whether it includes the dot or not. I decided to add it to the docstring so I won't have to keep checking. 


https://bugs.python.org/issue38422



Automerge-Triggered-By: @pitrou
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants