Skip to content

docs: add Raises and Examples to load_config_and_datastore in config.py (builds on #252)#490

Closed
Seai5 wants to merge 1 commit intomllam:mainfrom
Seai5:docs-add-raises-examples-config
Closed

docs: add Raises and Examples to load_config_and_datastore in config.py (builds on #252)#490
Seai5 wants to merge 1 commit intomllam:mainfrom
Seai5:docs-add-raises-examples-config

Conversation

@Seai5
Copy link
Copy Markdown

@Seai5 Seai5 commented Mar 22, 2026

Describe your changes

This PR adds Raises and Examples sections to the load_config_and_datastore function in config.py.

  • Raises section documents common exceptions (FileNotFoundError, ValueError, InvalidConfigError, etc.)
  • Examples section shows practical usage for better beginner understanding

This makes the docstring more complete and user-friendly, complementing #252 (100% docstring coverage PR).

Issue Link

#252
Related: closed #460 (redirected to #252 by @sadamov)

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 to cover introduced code changes
☐ I have added tests that prove my fix is effective or that my feature works
☑ I have given the PR a name that clearly describes the change, written in imperative form (context).
☐ I have requested a reviewer and an assignee (assignee is responsible for merging). This applies only if you have write access to the repo, otherwise feel free to tag a maintainer to add a reviewer and assignee.

Checklist for reviewers

  • the code is readable
  • the code is well tested
  • 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, in a section reflecting type of change (add section where missing):
☐ added
☐ changed
☐ fixes
☐ maintenance

@kshirajahere
Copy link
Copy Markdown
Contributor

Hey @Seai5 Please follow the PR template

@Seai5
Copy link
Copy Markdown
Author

Seai5 commented Mar 22, 2026

Hi @kshirajahere,

Thank you for the reminder!

I just updated the PR description to follow the template.

Let me know if anything is still missing or needs adjustment.

Best regards,
hrithik

@sadamov
Copy link
Copy Markdown
Collaborator

sadamov commented Mar 23, 2026

@Seai5 since this change is small I propose to add it as a review comment in #252 directly instead of opening a new PR here (which is also pointing to main)

@sadamov sadamov closed this Mar 23, 2026
@Seai5
Copy link
Copy Markdown
Author

Seai5 commented Mar 25, 2026

Hi @sadamov,

Thank you for the review and guidance!

I understand — I'll add the Raises + Examples improvements as a review comment directly on #252 instead.

Appreciate the feedback

Best,
hrithik

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.

4 participants