docs: move utilites inline, like other modules#1103
Open
docs: move utilites inline, like other modules#1103
Conversation
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs for utilities was in a
.rstfile, 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
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. ↩