Enhance SH documentation #260
Open
+67
−129
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
f-brinkmann
requested review from
a team,
ahms5,
Copilot,
hoyer-a,
mberz,
sikersten and
tluebeck
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation of spherical harmonics (SH) classes by improving consistency, clarity, and organization of docstrings. The mathematical definitions of SH have been removed from the class docstring as they will be documented at the module level instead.
Changes:
- Streamlined class-level docstring by removing detailed mathematical formulations
- Improved parameter descriptions with more precise language and better formatting
- Updated property docstrings for better clarity and consistency
- Enhanced documentation of gradient methods with references to coordinate system definitions
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Changes proposed in this pull request:
Many SH properties and methods are used in multiple classes or functions but they are not documented consistently with respect to each other and our guidelines. This is a suggestion for the documentation based on the
SphericalHarmonicsand_SpharicalHarmonicBaseclasses. Once we agree on something. The documentation can be unified everywhere in spharpy.Note that