Repository navigation
glob module docs in wrong order #110417
Description
The documentation of the glob module is in a slightly odd order:
- A description of the globbing language (wildcards etc)
- A "see also: pathlib" block
- Function documentation:
a.glob()
b.iglob()
c.escape() - Two examples of using
glob() - A "see also: fnmatch" block
In particular, the description of glob() and the examples of its usage are interrupted by descriptions of iglob() and escape().
I think this might be better:
- A description of the globbing language (wildcards etc)
- A "see also: fnmatch" block
- A "see also: pathlib" block
- Function documentation:
a.glob(), including two examples of its usage
b.iglob()
c.escape()
Activity
pythonGH-110417: Improve ordering of info in `glob` docs
Merge branch 'main' into pythongh-110417-glob-docs-ordering
GH-110417: Fix `glob` docs ordering (#110418)
terryjreedy commentedon Nov 13, 2023
Why not backport? Conflicts from changes?
barneygale commentedon Nov 13, 2023
Conflicts, and the changes in 3.12 and prior seem to minor to be worth it I think.
I can backport if you think it's worthwhile?
pythonGH-110417: Fix `glob` docs ordering (python#110418)
pythonGH-110417: Fix `glob` docs ordering (python#110418)