Fixes display of inherited members of classes #404
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
I inadvertently added a Jinja syntax error in naparigh-316. Also adds a comment to explain why this is necessary.
github-actions
bot
added
the
documentation
|
Before: https://napari.org/dev/api/napari.components.Camera.html (for example)
After:
|
psobolewskiPhD
approved these changes
Apr 12, 2024
lucyleeow
reviewed
Apr 16, 2024
| {% endif %} | ||
| {#- These classes inherit docstrings from the raw qt source, which generates rst syntax errors when building the docs #} | ||
| {% if objname not in ["progress", "cancelable_progress"] -%} | ||
| :inherited-members: |
There was a problem hiding this comment.
Question only, does this need to be indented, or is that just style?
There was a problem hiding this comment.
It can't be indented - that's what I had gotten wrong before. :inherited-members: needs to have the same indentation level as :show-inheritance: and the other options, and we can't have any whitespace between these directive options (which is why the jinja template lines start and end with an extra - (this prevents extra whitespace from appearing in the final document)
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.
References and relevant issues
Follow-up to #316
Description
I inadvertently added a Jinja syntax error in #316. Also adds a comment to explain why this is necessary.