Only use | None for optional parameters if appropriate
#14
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
The prefix in ":class:`Foo`" is actually optional for Sphinx to detect it as a reference. So allow "`Foo`" too.
This commit also includes a few other tweaks. I should really pay a bit more attention to making more focused changes. Partial commits only get you so far... A minor change is that `PackageFile` was replaced with `module_name_from_path` which should make for a more sensible approach that doesn't rely as much on carrying a subclass of `Path` around.
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.
Closes #13.
This also includes a few other tweaks. I should really pay a bit more attention to making more focused changes. Partial commits only get you so far...
A minor change is that
PackageFilewas replaced withmodule_name_from_pathwhich should make for a more sensible approach that doesn't rely as much on carrying a subclass ofPatharound.The prefix in ":class:
Foo" is actually optional for Sphinx to detectit as a reference. So allow "
Foo" too.