[issue41946] Add concrete examples to os.path documentation

[Jack DeVries]

Jack DeVries  added the comment:

> Some examples were added since this issue was created

See bpo-35183

--
nosy: +jack__d

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41946] Add concrete examples to os.path documentation

[Raymond Hettinger]

Raymond Hettinger  added the comment:

If some examples are added, the should note which operating system is being 
used.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41946] Add concrete examples to os.path documentation

[Raymond Hettinger]

Raymond Hettinger  added the comment:

Concrete examples for os.path are problematic because typical inputs and 
outputs vary across difference file systems.  The point of os.path is to hide 
these differences.

--
nosy: +rhettinger

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41946] Add concrete examples to os.path documentation

[Andrei Kulakov]

Andrei Kulakov  added the comment:

Some examples were added since this issue was created, but more can be added. 
Stargirl: feel free to open a PR, I can review it.

--
nosy: +andrei.avk

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue41946] Add concrete examples to os.path documentation

[Stargirl Flowers]

New submission from Stargirl Flowers :

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@python
components: Documentation
messages: 378043
nosy: docs@python, theacodes
priority: normal
severity: normal
status: open
title: Add concrete examples to os.path documentation
type: enhancement

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com