Skip to content

Improve docs 252#515

Open
Omnagar wants to merge 13 commits intomllam:mainfrom
Omnagar:improve-docs-252
Open

Improve docs 252#515
Omnagar wants to merge 13 commits intomllam:mainfrom
Omnagar:improve-docs-252

Conversation

@Omnagar
Copy link
Copy Markdown

@Omnagar Omnagar commented Mar 24, 2026

Describe your changes

Improved docstring coverage and consistency across the following modules:

  • weather_dataset.py
  • config.py
  • utils.py

Changes include:

  • Adding missing docstrings to functions and classes
  • Removing duplicate or redundant docstrings
  • Aligning parameter names with function signatures
  • Fixing grammar, formatting, and readability issues
  • Ensuring all docstrings comply with linting rules (flake8, interrogate)

These updates improve overall code readability, maintainability, and documentation quality in line with the goals of PR #252.

No external dependencies were introduced.

Issue Link

Related to #252

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation (Addition or improvements to 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 any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
  • I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
  • I have updated the README (not required for this change)
  • I have added tests (not applicable for documentation changes)
  • I have given the PR a name that clearly describes the change

Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should check the following:

  • the code is readable
  • the code is well tested (not applicable)
  • the code is documented (including return types and parameters)
  • the code is easy to maintain

Author checklist after completed review

  • I have added a line to the CHANGELOG describing this change (maintenance)

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • PR is assigned to the appropriate milestone
  • author has added an entry to the changelog
  • Once the PR is ready to be merged, squash commits and merge the PR.

@Omnagar
Copy link
Copy Markdown
Author

Omnagar commented Mar 24, 2026

Hi, I’ve contributed additional docstring improvements for related modules
(weather_dataset.py, config.py, utils.py) via a PR against @Mohit-Lakra’s branch.

Happy to align further if needed.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants