Skip to content

docs: move utilites inline, like other modules#1103

Merged
henryiii merged 1 commit intopypa:mainfrom
henryiii:henryiii/docs/inline
Mar 8, 2026
Merged

docs: move utilites inline, like other modules#1103
henryiii merged 1 commit intopypa:mainfrom
henryiii:henryiii/docs/inline

Conversation

@henryiii
Copy link
Copy Markdown
Contributor

@henryiii henryiii commented Mar 6, 2026

The docs for utilities was in a .rst file, rather than being in the docstrings like most other modules (except markers, which has the same problem1). I moved it to match. The order is a little different, and there's a little more documentation in a couple of cases where it existed in both places, so I merged it. The docs are a little more accurate now too, showing things like keyword only arguments correctly.

I also added a little copy-paste printout to the docs job to make viewing a little easier. I might add the full interactive check many nox docs jobs have later, but this is handy and minimally intrusive.

AI usage disclaimer: After moving everything by hand, the doctest style was inconsistent and some were broken with missing imports, so I asked copilot in VSCode to match the style of doctest blocks to the rest of the codebase.

Footnotes

  1. actually a couple other too, one has some reason (tags is split up into high/low level interface), but these pages are just simple reference.

@notatallshaw
Copy link
Copy Markdown
Member

Makes sense to me.

@henryiii henryiii force-pushed the henryiii/docs/inline branch from 091b326 to c5acdde Compare March 8, 2026 14:53
@henryiii henryiii merged commit d35d664 into pypa:main Mar 8, 2026
56 checks passed
@henryiii henryiii deleted the henryiii/docs/inline branch March 8, 2026 15:15
ngoldbaum pushed a commit to ngoldbaum/packaging that referenced this pull request Apr 1, 2026
This was referenced Apr 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants