Standardize docstrings in metrics module to Google-style format - #321
Closed
yukthagangadhari5 wants to merge 1 commit into
Closed
Standardize docstrings in metrics module to Google-style format#321yukthagangadhari5 wants to merge 1 commit into
yukthagangadhari5 wants to merge 1 commit into
Conversation
Collaborator
|
this is a duplicate of #252 , please add your contribution there |
Author
|
Thanks for the clarification. I wasn’t aware that similar changes were already being tracked in #252. Please let me know if you'd prefer a specific approach for integrating them. |
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.
Describe your changes
This PR standardizes the docstrings in
neural_lam/metrics.pyto aconsistent Google-style format.
The goal is to improve documentation clarity and ensure compatibility
with Sphinx + napoleon for automated API generation.
Changes are documentation-only and do not modify any functionality.
No behavioral changes introduced.
Issue Link
Related to #61 (structured documentation improvements)
Type of change
Checklist before requesting a review