Doc: fix referencing in spherical submod#138
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes documentation warnings in the spherical module by updating reference citations in the docstrings.
- Updated the reference section in spherical_harmonic_basis_gradient to include an additional reference.
- Reorganized the references in spherical_harmonic_basis_gradient_real to improve clarity during documentation build.
github-project-automation
Bot
moved this from Require review
to Reviewer Approved
in Weekly Planning
hoyer-a
reviewed
Jun 2, 2025
| derived in [#]_ and [#]_. | ||
|
|
||
|
|
||
| References |
Member
There was a problem hiding this comment.
Maybe also move the references to the end of the function docstring?
hoyer-a
approved these changes
Jun 2, 2025
github-project-automation
Bot
moved this from Reviewer Approved
to Done
in Weekly Planning
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
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.
Which issue(s) are closed by this pull request?
contribues to fix all warnings during documentation build
Changes proposed in this pull request: