Add docstrings to app title an sub-titles #1570
Merged
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.
As of now this doesn't result in documentation appearing for everything; it seems that something in our documentation chain (perhaps
mkdocstrings
) treats properties as case-insensitive; so when there's a docstring forTITLE
andtitle
only the former seems to show up in the docs.At some point soon I'll try and isolate this issue to the correct part of the documentation pipeline and make an issue. Meanwhile, this gets docstrings in place (which is also a benefit to development environments which show docstrings).
Edit to add: Testing the mkdocs/mkdocs-material/mkdocstrings pipeline in isolation, this isn't a problem. Need to look into that aspect some more (as an aside from this).