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()
Linked PRs
The documentation of the
globmodule is in a slightly odd order:a.
glob()b.
iglob()c.
escape()glob()In particular, the description of
glob()and the examples of its usage are interrupted by descriptions ofiglob()andescape().I think this might be better:
a.
glob(), including two examples of its usageb.
iglob()c.
escape()Linked PRs
globdocs ordering #110418