doc: add dual navigation buttons and cleanup some docstrings #758
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #758 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 135 135
Lines 8920 8919 -1
Branches 2002 2002
=========================================
- Hits 8920 8919 -1 ☔ View full report in Codecov by Sentry. |
laurencap
reviewed
Jan 31, 2024
laurencap
previously approved these changes
Feb 1, 2024
speller26
previously approved these changes
Feb 2, 2024
Comment on lines
+38
to
+39
| napoleon_google_docstring = True | ||
| napoleon_numpy_docstring = False |
There was a problem hiding this comment.
Out of curiosity, why is this explicitly necessary?
There was a problem hiding this comment.
napoleon_numpy_docstring defaults to true so I was explicitly setting these values within the conf.
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.
Issue #, if available:
Description of changes:
Testing done:
Merge Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.General
Tests
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.