Skip to content

bpo-43620: Remove reference to os.sep from os.path.join() doc#25025

Merged
freddrake merged 2 commits into
python:masterfrom
jpsutton:master
Mar 26, 2021
Merged

bpo-43620: Remove reference to os.sep from os.path.join() doc#25025
freddrake merged 2 commits into
python:masterfrom
jpsutton:master

Conversation

@jpsutton

@jpsutton jpsutton commented Mar 26, 2021 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

Bug Report: https://bugs.python.org/issue43620

Summary: This patch removes a reference to os.sep from the os.path.join() documentation, since os.sep is not actually referenced in the implementation, and its presence in the doc can be confusing.

https://bugs.python.org/issue43620

@the-knights-who-say-ni

the-knights-who-say-ni commented Mar 26, 2021

Copy link
Copy Markdown

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

CLA Missing

Our records indicate the following people have not signed the CLA:

@jpsutton

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Mar 26, 2021
@jpsutton

jpsutton commented Mar 26, 2021

Copy link
Copy Markdown
Contributor Author

I don't have write access, so I can't apply a label, but I think this PR should have the skip news label applied.

freddrake
freddrake requested changes Mar 26, 2021
View reviewed changes

@freddrake freddrake left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please remove the text about what the separator is on different platforms.

Comment thread Doc/library/os.path.rst Outdated
Comment on lines +313 to +315

On Windows, the directory separator is a backslash, while on POSIX platforms
it is a forward slash.

@freddrake freddrake Mar 26, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Leave this part out.

What the separator is affects many functions in os.path, not only join(). If it needs to be documented for os.path, it's better to document os.path.sep, and to describe there that it's informative, and not intended to be modified.

Since this isn't a factor in bpo-43620, it should not be a part of this PR.

Comment thread Doc/library/os.path.rst
@bedevere-bot

bedevere-bot commented Mar 26, 2021

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@jpsutton

jpsutton commented Mar 26, 2021

Copy link
Copy Markdown
Contributor Author

I have made the requested changes; please review again.

@bedevere-bot

bedevere-bot commented Mar 26, 2021

Copy link
Copy Markdown

Thanks for making the requested changes!

@freddrake: please review the changes made to this pull request.

@bedevere-bot bedevere-bot requested a review from freddrake March 26, 2021 15:29
@jpsutton jpsutton marked this pull request as ready for review March 26, 2021 15:40
freddrake
freddrake approved these changes Mar 26, 2021
View reviewed changes

@freddrake freddrake left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for contributing, Jared!

@freddrake freddrake merged commit 21a2cab into python:master Mar 26, 2021
@bedevere-bot

bedevere-bot commented Mar 26, 2021

Copy link
Copy Markdown

@freddrake: Please replace # with GH- in the commit message next time. Thanks!

@miss-islington

miss-islington commented Mar 26, 2021

Copy link
Copy Markdown
Contributor

Thanks @jpsutton for the PR, and @freddrake for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9.
🐍🍒⛏🤖

@bedevere-bot

bedevere-bot commented Mar 26, 2021

Copy link
Copy Markdown

GH-25027 is a backport of this pull request to the 3.9 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 26, 2021
@jpsutton @miss-islington
bpo-43620: Remove reference to os.sep from os.path.join() doc (python…
c8a3366 
…GH-25025)

- removed ambiguous reference to os.sep from os.path.join() doc
(cherry picked from commit 21a2cab)

Co-authored-by: Jared Sutton <jpsutton@gmail.com>
freddrake pushed a commit that referenced this pull request Mar 26, 2021
@miss-islington @jpsutton
bpo-43620: Remove reference to os.sep from os.path.join() doc (GH-25025…
f311290 
…) (#25027)

- removed ambiguous reference to os.sep from os.path.join() doc
(cherry picked from commit 21a2cab)

Co-authored-by: Jared Sutton <jpsutton@gmail.com>
@miss-islington

miss-islington commented Mar 26, 2021

Copy link
Copy Markdown
Contributor

Thanks @jpsutton for the PR, and @freddrake for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

@bedevere-bot

bedevere-bot commented Mar 26, 2021

Copy link
Copy Markdown

GH-25030 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 Mar 26, 2021
@jpsutton @miss-islington
bpo-43620: Remove reference to os.sep from os.path.join() doc (python…
b469200 
…GH-25025)

- removed ambiguous reference to os.sep from os.path.join() doc
(cherry picked from commit 21a2cab)

Co-authored-by: Jared Sutton <jpsutton@gmail.com>
@freddrake

freddrake commented Mar 26, 2021

Copy link
Copy Markdown
Member

Sorry; didn't originally add the backport-to-3.8 tag; done now.

freddrake pushed a commit that referenced this pull request Mar 26, 2021
@miss-islington @jpsutton
bpo-43620: Remove reference to os.sep from os.path.join() doc (GH-25025…
455583b 
…, GH-5030)

- removed ambiguous reference to os.sep from os.path.join() doc
(cherry picked from commit 21a2cab)

Co-authored-by: Jared Sutton <jpsutton@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@freddrake freddrake freddrake approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@jpsutton @the-knights-who-say-ni @bedevere-bot @miss-islington @freddrake @ammaraskar