Skip to content

Standardize docstrings in metrics module to Google-style format - #321

Closed
yukthagangadhari5 wants to merge 1 commit into
mllam:mainfrom
yukthagangadhari5:docs/metrics-docstring-standardization
Closed

Standardize docstrings in metrics module to Google-style format#321
yukthagangadhari5 wants to merge 1 commit into
mllam:mainfrom
yukthagangadhari5:docs/metrics-docstring-standardization

Conversation

@yukthagangadhari5

Copy link
Copy Markdown

Describe your changes

This PR standardizes the docstrings in neural_lam/metrics.py to a
consistent 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

  • 🐛 Bug fix
  • ✨ New feature
  • 💥 Breaking change
  • 📖 Documentation

Checklist before requesting a review

  • My branch is up-to-date with the target branch
  • I have performed a self-review of my code
  • For modified functions I have added standardized docstrings
  • I have updated the README (not applicable)
  • I have added tests (not applicable — documentation-only change)

@sadamov

sadamov commented Mar 3, 2026

Copy link
Copy Markdown
Collaborator

this is a duplicate of #252 , please add your contribution there

@sadamov sadamov closed this Mar 3, 2026
@sadamov sadamov added the duplicate This issue or pull request already exists label Mar 3, 2026
@yukthagangadhari5

Copy link
Copy Markdown
Author

Thanks for the clarification.

I wasn’t aware that similar changes were already being tracked in #252.
Happy to contribute the docstring updates there instead.

Please let me know if you'd prefer a specific approach for integrating them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

duplicate This issue or pull request already exists

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants