Skip to content

feat: document configuration options#91

Merged
WojtAcht merged 3 commits intomainfrom
feature/document-configuration-options
Apr 30, 2025
Merged

feat: document configuration options#91
WojtAcht merged 3 commits intomainfrom
feature/document-configuration-options

Conversation

@WojtAcht
Copy link
Collaborator

No description provided.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link

codecov bot commented Apr 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.31%. Comparing base (981a207) to head (10c63c1).
Report is 2 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@WojtAcht WojtAcht merged commit 60de1f4 into main Apr 30, 2025
2 of 3 checks passed
@WojtAcht WojtAcht deleted the feature/document-configuration-options branch April 30, 2025 07:49
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)
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.

3 participants