[issue41946] Add concrete examples to os.path documentation

Stargirl Flowers report at bugs.python.org
Mon Oct 5 12:06:07 EDT 2020


New submission from Stargirl Flowers <me at thea.codes>:

Presently the documentation for os.path (https://docs.python.org/3.8/library/os.path.html) doesn't contain any concrete examples of the input and outputs of the various path manipulation functions.

Contrast this to the Node.js documentation for similar functionality (https://nodejs.org/api/path.html)

We could add replesque examples such as:

>> os.path.abspath("example.py")
"/full/path/to/example.py"

...

>> os.path.basename("example.py")
"example"

& so on.

I believe it would be useful for us to have concrete examples here and I'm happy to contribute this. If anyone feels differently, let me know.

----------
assignee: docs at python
components: Documentation
messages: 378043
nosy: docs at python, theacodes
priority: normal
severity: normal
status: open
title: Add concrete examples to os.path documentation
type: enhancement

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue41946>
_______________________________________


More information about the Python-bugs-list mailing list