GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — bpo-33426: [doc] Behavior of os.path.join does not match documentation by DonnaDia · Pull Request #28003 · python/cpython

Conversation

@DonnaDia

@DonnaDia DonnaDia commented Aug 27, 2021 •
edited by bedevere-bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

https://bugs.python.org/issue33426

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@DonnaDia
provided a more clear explanation
9b0f95c
@the-knights-who-say-ni the-knights-who-say-ni added the CLA signed label Aug 27, 2021
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir labels Aug 27, 2021
zware
zware requested changes Aug 31, 2021
View reviewed changes
Comment thread Doc/library/os.path.rst
that the result will only end in a separator if the last part is empty. If
a component is an absolute path, all previous components are thrown away
and joining continues from the absolute path component.
Join one or more path components intelligently. The return value is the

@zware zware Aug 31, 2021

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

As far as I can tell, the only change on this line is to change two spaces into one. That's not an inherently bad change, but it does make it rather more difficult to tell what actually changed in the wording of this paragraph. Please refrain from formatting changes like this when they're mixed in with other changes and are the only change on a line.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
serhiy-storchaka reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread Doc/library/os.path.rst
a component is an absolute path, all previous components are thrown away
and joining continues from the absolute path component.
Join one or more path components intelligently. The return value is the
concatenation of path and any members of *\*paths* so that there is a

@zware zware Aug 31, 2021

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

path is a parameter name, so it should keep its * markings:

Suggested change
concatenation of path and any members of *\*paths* so that there is a
concatenation of *path* and any members of *\*paths* so that there is a

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
serhiy-storchaka reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread Doc/library/os.path.rst
and joining continues from the absolute path component.
Join one or more path components intelligently. The return value is the
concatenation of path and any members of *\*paths* so that there is a
directory separator (os.sep) following each part except the last.

@zware zware Aug 31, 2021

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

The os.sep mention was specifically removed in bpo-43620; I don't think we should add it back. It could perhaps be "(platform-specific)" instead of "(os.sep)"?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
serhiy-storchaka reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread Doc/library/os.path.rst
An empty part is ignored unless it is the last part, in which case the result
will end in a separator. If a component is an absolute path, all previous
components are thrown away and joining continues from the absolute path
component.

@zware zware Aug 31, 2021

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

It also looks like there are no changes to this last sentence, but it's harder to tell due to the reflowing of text. For ease of review, please leave reflowing for after the main change has been approved (or even leave it un-reflowed; Sphinx takes care of wrapping lines independently of how the source markup looks).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
serhiy-storchaka reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread Doc/library/os.path.rst
Comment on lines +308 to +311
concatenation of path and any members of *\*paths* so that there is a
directory separator (os.sep) following each part except the last.
An empty part is ignored unless it is the last part, in which case the result
will end in a separator. If a component is an absolute path, all previous

@zware zware Aug 31, 2021

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

In looking into this, it looks like I'm actually the one who last made major changes to this section 7 years ago, and I now agree that I did leave it rather confusing. Oops :)

I think the following is a slightly better formulation; do you agree?

Suggested change
concatenation of path and any members of *\*paths* so that there is a
directory separator (os.sep) following each part except the last.
An empty part is ignored unless it is the last part, in which case the result
will end in a separator. If a component is an absolute path, all previous
concatenation of *path* and any non-empty members of *\*paths* separated
by the platform's directory separator character. If the last member of *\*paths*
is empty, the result will end in a directory separator.
If a component is an absolute path, all previous

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
serhiy-storchaka reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@bedevere-bot bedevere-bot added awaiting changes and removed awaiting review labels Aug 31, 2021
@bedevere-bot

bedevere-bot commented Aug 31, 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.

And if you don't make the requested changes, you will be put in the comfy chair!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@zware zware added the skip news label Aug 31, 2021
@github-actions

github-actions Bot commented Oct 1, 2021

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Oct 1, 2021
@iritkatriel

iritkatriel commented Jan 14, 2022

Copy link
Copy Markdown
Member

@DonnaDia Are you still working on this PR?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@ezio-melotti ezio-melotti removed the CLA signed label Jul 13, 2022
@github-actions github-actions Bot removed the stale Stale PR or inactive for long period of time. label Aug 12, 2022
@slateny

slateny commented Oct 9, 2022

Copy link
Copy Markdown
Contributor

@DonnaDia Would you still be interested in giving this PR a quick update per the comments above? If not, I can open a separate PR and get these changes in.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@MichaelKlatt MichaelKlatt mannequin mentioned this pull request Apr 10, 2022
[doc] Behavior of os.path.join does not match documentation #77607
Closed
@slateny

slateny commented Nov 2, 2022

Copy link
Copy Markdown
Contributor

See #98995
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@slateny slateny closed this Nov 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zware zware zware requested changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

awaiting changes docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

7 participants

@DonnaDia @bedevere-bot @iritkatriel @slateny @zware @the-knights-who-say-ni @ezio-melotti
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.