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
Closed
docs: add Raises and Examples to load_config_and_datastore in config.py (builds on #252)#490Seai5 wants to merge 1 commit intomllam:mainfrom
Seai5 wants to merge 1 commit intomllam:mainfrom
Conversation
…n config.py (builds on mllam#252)
Contributor
|
Hey @Seai5 Please follow the PR template |
Author
|
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, |
Collaborator
Author
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 adds Raises and Examples sections to the
load_config_and_datastorefunction inconfig.py.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
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