Skip to content

[3.14] gh-136437: Convert more os.path functions to positional-only in the docs (GH-136970) #137000

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: 3.14
Choose a base branch
from
Open

[3.14] gh-136437: Convert more os.path functions to positional-only in the docs (GH-136970) #137000

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions Doc/library/os.path.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ the :mod:`glob` module.)
Any iterable can now be passed, rather than just sequences.


.. function:: commonprefix(list)
.. function:: commonprefix(list, /)

Return the longest path prefix (taken character-by-character) that is a
prefix of all paths in *list*. If *list* is empty, return the empty string
Expand Down Expand Up @@ -199,14 +199,14 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`.


.. function:: getatime(path)
.. function:: getatime(path, /)

Return the time of last access of *path*. The return value is a floating-point number giving
the number of seconds since the epoch (see the :mod:`time` module). Raise
:exc:`OSError` if the file does not exist or is inaccessible.


.. function:: getmtime(path)
.. function:: getmtime(path, /)

Return the time of last modification of *path*. The return value is a floating-point number
giving the number of seconds since the epoch (see the :mod:`time` module).
Expand All @@ -216,7 +216,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`.


.. function:: getctime(path)
.. function:: getctime(path, /)

Return the system's ctime which, on some systems (like Unix) is the time of the
last metadata change, and, on others (like Windows), is the creation time for *path*.
Expand All @@ -228,7 +228,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`.


.. function:: getsize(path)
.. function:: getsize(path, /)

Return the size, in bytes, of *path*. Raise :exc:`OSError` if the file does
not exist or is inaccessible.
Expand Down Expand Up @@ -351,7 +351,7 @@ the :mod:`glob` module.)
.. versionadded:: 3.13


.. function:: join(path, *paths)
.. function:: join(path, /, *paths)

Join one or more path segments intelligently. The return value is the
concatenation of *path* and all members of *\*paths*, with exactly one
Expand Down Expand Up @@ -402,7 +402,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`.


.. function:: realpath(path, *, strict=False)
.. function:: realpath(path, /, *, strict=False)

Return the canonical path of the specified filename, eliminating any symbolic
links encountered in the path (if they are supported by the operating
Expand Down Expand Up @@ -471,7 +471,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`.


.. function:: samefile(path1, path2)
.. function:: samefile(path1, path2, /)

Return ``True`` if both pathname arguments refer to the same file or directory.
This is determined by the device number and i-node number and raises an
Expand All @@ -498,7 +498,7 @@ the :mod:`glob` module.)
Accepts a :term:`path-like object`.


.. function:: samestat(stat1, stat2)
.. function:: samestat(stat1, stat2, /)

Return ``True`` if the stat tuples *stat1* and *stat2* refer to the same file.
These structures may have been returned by :func:`os.fstat`,
Expand Down
Loading