Fix type alias and generic in documentation #67
Merged
Conversation
This file contains 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
Scienfitz
approved these changes
Dec 15, 2023
Scienfitz
approved these changes
Dec 15, 2023
AdrianSosic
approved these changes
Dec 15, 2023
There was a problem hiding this comment.
Hey @AVHopp, thanks for the fix 👍🏼 I think the changes are fine, but my only concern is that I don't really know how sustainable this solution is. All I can say: "Smiles" and the two TypeVars is not all --> there will certainly be more of that stuff in the future and especially the upcoming typing PRs. But I completely leave this decision to you, since you have the overview of the docs. If you think this is the way to go, then go! But be prepared for more "exceptions" to come :D
AVHopp
commented
Dec 18, 2023
AVHopp
force-pushed
the
docs/fix_links
branch
from
891b3e6
to
913f529
Compare
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.
This PR fixes the following minor errors in the documentation.
Smilestype alias introduced inparameters.substance. This type alias is manually configured inconf.py. In order to avoid the documentation to load all of the attributes and functions ofstr, the templates were changed slightly to not include those, resulting in the output shown at the end.baybe.utils.basic. Sphinx behaves weird when using generics (see Use of TypeVar results in "reference target not found" error sphinx-doc/sphinx#10974). Thus, an exception was included in the nitpick_ignore dictionary, eliminating the error.