Skip to content

gh-130536: Improve os.path documentation#131872

Closed
hridyasadanand wants to merge 1 commit into
python:mainfrom
hridyasadanand:main
Closed

gh-130536: Improve os.path documentation#131872
hridyasadanand wants to merge 1 commit into
python:mainfrom
hridyasadanand:main

Conversation

@hridyasadanand

@hridyasadanand hridyasadanand commented Mar 29, 2025

Copy link
Copy Markdown

Added cross-references to related functions and provided an example for os.path.join to enhance clarity.


📚 Documentation preview 📚: https://cpython-previews--131872.org.readthedocs.build/

Added cross-references to related functions and provided an example for os.path.join to enhance clarity.
@ghost

ghost commented Mar 29, 2025

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

@StanFromIreland StanFromIreland 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.

Very messy

Comment thread Doc/library/os.path.rst
Return ``True`` if *path* is an absolute pathname.

.. seealso::
:func:`os.path.abspath` - for converting paths to absolute paths. On Unix, that means it

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.

This is a mess

Comment thread Doc/library/os.path.rst
Comment on lines +247 to +248
.. seealso::
:func:`os.path.abspath` - for converting paths to absolute paths. On Unix, that means it

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.

Usually these are put at the end of the note

Comment thread Doc/library/os.path.rst
Comment on lines +367 to 368
'/home/bar' The return value is the
concatenation of *path* and all members of *\*paths*, with exactly one

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.

Needs to be fixed

Comment thread Doc/library/os.path.rst
Comment on lines +506 to 507
:func:`os.path.join` - for joining paths efficiently. The
*tail* part will never contain a slash; if *path* ends in a slash, *tail*

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.

Again a mess

@picnixz

picnixz commented Mar 29, 2025

Copy link
Copy Markdown
Member

#130557 already exists. Please do not open PRs when an open PR against the issue already exists. TiA.

@picnixz picnixz closed this Mar 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants