Fix rendering of Google-style docstrings #2061
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
Balandat
approved these changes
Jul 12, 2022
gpleiss
approved these changes
Jul 12, 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.
Many docstrings use Google-style conventions and require the sphinx.ext.napoleon extension to render correctly.
For example, gpytorch.kernels.PeriodicKernel uses Python-style
:param:lists and renders correctly, but gpytorch.kernels.ScaleKernel uses Google-styleArgs:lists and is not rendered correctly. This PR fixes that: before, after.Fixing this uncovered a lot of other issues in the docs.
:attr:should only be used to cross-reference class attributes, not to define or cross-reference function parameters.