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

[DOC] Update to HSSM documentation for better organization and code formatting #614

Conversation

digicosmos86
Copy link
Collaborator

@AlexanderFengler This is now purely just documentation changes. Mainly just better organization in the API section highlighting core functionalities. A few latest updates are not added though, such as the model cartoon plots. Please feel free to add them yourself

@digicosmos86 digicosmos86 changed the title [DOC ]Update to HSSM documentation for better organization and code formatting [DOC] Update to HSSM documentation for better organization and code formatting Dec 20, 2024
Copy link

codecov bot commented Dec 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Copy link
Collaborator

@AlexanderFengler AlexanderFengler left a comment

Choose a reason for hiding this comment

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

lgtm

@AlexanderFengler AlexanderFengler merged commit 577cdc4 into main Dec 31, 2024
5 checks passed
@@ -14,26 +14,40 @@
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/lnccbrown/HSSM/run_slow_tests.yml)
![GitHub Repo stars](https://img.shields.io/github/stars/lnccbrown/HSSM)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![codecov](https://codecov.io/gh/lnccbrown/HSSM/branch/main/graph/badge.svg)](https://codecov.io/gh/lnccbrown/HSSM)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a reason for deleting this line?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sorry this PR came before the CodeCov update and somehow backtracked some of the latter updates. Please feel free to ad it back. Thanks!

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.

[Documentation] Update to HSSM documentation for better organization and code formatting
3 participants