[issue35183] os.path.splitext documentation needs typical example

[Łukasz Langa]

Łukasz Langa  added the comment:

Thanks, Jake! ✨  ✨

--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

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

[issue35183] os.path.splitext documentation needs typical example

[Łukasz Langa]

Łukasz Langa  added the comment:


New changeset 14cb669357bc30bdc235d1c32ee1b99be05ac9d8 by Miss Islington (bot) 
in branch '3.10':
bpo-35183: Add typical examples to os.path.splitext docs (GH-27286) (GH-27563)
https://github.com/python/cpython/commit/14cb669357bc30bdc235d1c32ee1b99be05ac9d8


--

___
Python tracker 

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

[issue35183] os.path.splitext documentation needs typical example

[Łukasz Langa]

Łukasz Langa  added the comment:


New changeset e0d599fa48032eb7b8d837f8412bbca72b6ad820 by Miss Islington (bot) 
in branch '3.9':
bpo-35183: Add typical examples to os.path.splitext docs (GH-27286) (GH-27564)
https://github.com/python/cpython/commit/e0d599fa48032eb7b8d837f8412bbca72b6ad820


--

___
Python tracker 

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

[issue35183] os.path.splitext documentation needs typical example

[miss-islington]

Change by miss-islington :


--
nosy: +miss-islington
nosy_count: 5.0 -> 6.0
pull_requests: +26070
pull_request: https://github.com/python/cpython/pull/27563

___
Python tracker 

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

[issue35183] os.path.splitext documentation needs typical example

[miss-islington]

Change by miss-islington :


--
pull_requests: +26071
pull_request: https://github.com/python/cpython/pull/27564

___
Python tracker 

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

[issue35183] os.path.splitext documentation needs typical example

[Łukasz Langa]

Łukasz Langa  added the comment:


New changeset aa0894b3792901adb91e5f6d049154b7bcb980ec by Jake Stockwin in 
branch 'main':
bpo-35183: Add typical examples to os.path.splitext docs (GH-27286)
https://github.com/python/cpython/commit/aa0894b3792901adb91e5f6d049154b7bcb980ec


--
nosy: +lukasz.langa

___
Python tracker 

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

[issue35183] os.path.splitext documentation needs typical example

[Jake Stockwin]

Jake Stockwin  added the comment:

Thanks for the info, @jack__d - very helpful.
I have now submitted a PR for this and will await a review. Let me know if 
anything else is needed.

--

___
Python tracker 

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

[issue35183] os.path.splitext documentation needs typical example

[Jake Stockwin]

Change by Jake Stockwin :


--
keywords: +patch
pull_requests: +25828
stage:  -> patch review
pull_request: https://github.com/python/cpython/pull/27286

___
Python tracker 

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

[issue35183] os.path.splitext documentation needs typical example

[Jack DeVries]

Jack DeVries  added the comment:

@jstockwin, the process usually goes like this:

1. You open a PR
2. The discussion continues over there. non-core-dev volunteers review your PR 
and get it into a polished state.
3. A core dev will quickly take a look, provide feedback if necessary, or just 
merge if not.

There's no need to credit anyone – if Shaun wanted credit, he could have 
included a PR with his bug report! Plus, the commit will include this bpo#, so 
future onlookers can always trace the commit back to this thread.

Follow the dev guide as you go and don't hesitate to post any questions you 
have right here!

--
nosy: +jack__d

___
Python tracker 

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

[issue35183] os.path.splitext documentation needs typical example

[Jake Stockwin]

Jake Stockwin  added the comment:

Hello, I would like to submit a PR for this.

It'll be my first contribution to cPython and I am slightly unclear if this 
suggestion has been "accepted" in some sense (i.e. do the Devs agree it should 
be fixed as suggested)?

If so, I will go ahead and create PR (and credit shaungriffith for his provided 
examples).

--
nosy: +jstockwin

___
Python tracker 

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

[issue35183] os.path.splitext documentation needs typical example

[Irit Katriel]

Change by Irit Katriel :


--
components: +Library (Lib)
keywords: +easy
versions: +Python 3.10, Python 3.11, Python 3.9 -Python 3.6

___
Python tracker 

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

[issue35183] os.path.splitext documentation needs typical example

[Shaun Griffith]

New submission from Shaun Griffith :

As with many entries on the os.path doc page, splitext needs a typical example. 
Not grokking the bare minimum text, I had to actually try it in the interpreter 
to see what it did.

The one example that *is* there is an edge case, and does nothing to explain 
the normal behavior, or why this is the correct behavior for the edge case.

Here is where I tripped up:

Split the pathname path into a pair (root, ext) such that root + ext == path, 
and ext is empty or begins with a period and contains at most one period.

One interpretation of this is that ext is either empty, or has a period, _and 
nothing else_. 

Here are 2 examples for typical use:

>>> splitext('readme.txt')
('readme', '.txt')
>>> splitext('/some/long/pathname/warble.csv')
('/some/long/pathname/warble', '.csv')

--
assignee: docs@python
components: Documentation
messages: 329414
nosy: docs@python, shaungriffith
priority: normal
severity: normal
status: open
title: os.path.splitext documentation needs typical example
type: enhancement
versions: Python 3.6

___
Python tracker 

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