docs: Fix Sphinx warnings #40
Merged
Conversation
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
We were using `T` as a stand-in for any valid parameter type, but Sphinx doesn't like that. Let's just use `Any` in the docs - the actual valid types are spelled out in the type stubs, but adding them to the documentation would make things unnecessarily verbose and repetitive. Likewise, we were using `Row` as a stand-in for whatever row type is configured using the `row_factory`, but let's just drop that and leave it implicit. Finally, use code formatting (double backticks) rather than references (single backticks) for some things that were never meant to be references. Signed-off-by: Matt Wozniski <mwozniski@bloomberg.net>
mariocj89
approved these changes
Aug 24, 2022
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.
We were using
Tas a stand-in for any valid parameter type, but Sphinxdoesn't like that. Let's just use
Anyin the docs - the actual validtypes are spelled out in the type stubs, but adding them to the
documentation would make things unnecessarily verbose and repetitive.
Likewise, we were using
Rowas a stand-in for whatever row type isconfigured using the
row_factory, but let's just drop that and leaveit implicit.
Finally, use code formatting (double backticks) rather than references
(single backticks) for some things that were never meant to be
references.
Signed-off-by: Matt Wozniski mwozniski@bloomberg.net