feat: document configuration options#91
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds detailed docstrings to various configuration methods within the pyhms/config.py file, improving clarity on configuration parameters for different evolutionary algorithm levels.
- Added descriptive parameter documentation for EA, DE, SHADE, and CMA-ES configurations.
- Enhanced clarity on default values and additional keyword parameters passed to the respective algorithm constructors.
Files not reviewed (2)
- docs/configuration_options.rst: Language not supported
- docs/index.rst: Language not supported
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #91 +/- ##
==========================================
- Coverage 77.34% 77.31% -0.03%
==========================================
Files 67 67
Lines 3151 3152 +1
==========================================
Hits 2437 2437
- Misses 714 715 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Hubert-Guzowski
approved these changes
Apr 30, 2025
Hubert-Guzowski
pushed a commit
that referenced
this pull request
Sep 16, 2025
feat: explain how to install pyHMS in Google Colab feat: document configuration options (#91)
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.
No description provided.