Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation of class attributes #147

Merged
merged 7 commits into from
Nov 13, 2024
Merged

Better documentation of class attributes #147

merged 7 commits into from
Nov 13, 2024

Conversation

TomWagg
Copy link
Owner

@TomWagg TomWagg commented Nov 13, 2024

Added docstrings for every attribute in Population and StarFormationHistory, as well as some tables to explain utils.translate_COSMIC_tables.

This will fix #146.

@TomWagg TomWagg added the documentation Improvements or additions to documentation label Nov 13, 2024
@TomWagg TomWagg self-assigned this Nov 13, 2024
Copy link

github-actions bot commented Nov 13, 2024

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
1725 1710 99% 0% 🟢

New Files

No new covered files...

Modified Files

File Coverage Status
cogsworth/classify.py 100% 🟢
cogsworth/pop.py 100% 🟢
cogsworth/sfh.py 100% 🟢
cogsworth/utils.py 100% 🟢
TOTAL 100% 🟢

updated for commit: 1c28763 by action🐍

@TomWagg TomWagg merged commit 966f25a into main Nov 13, 2024
2 checks passed
@TomWagg TomWagg deleted the docs branch November 13, 2024 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing descriptions in the docs
1 participant