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

updated docs for cryostat.py, dealt with TODO's in there as well. #3599

Merged
merged 1 commit into from
Sep 10, 2024

Conversation

OceanNuclear
Copy link
Contributor

@OceanNuclear OceanNuclear commented Sep 10, 2024

Linked Issues

Closes #3525

Description

Updated docs for the cryostat.py

Interface Changes

None

Checklist

I confirm that I have completed the following checks:

  • Tests run locally and pass pytest tests --reactor
  • Code quality checks run locally and pass pre-commit run --from-ref develop --to-ref HEAD
  • Documentation built locally and checked sphinx-build -W documentation/source documentation/build

@OceanNuclear OceanNuclear requested a review from a team as a code owner September 10, 2024 11:15
@je-cook je-cook enabled auto-merge (squash) September 10, 2024 11:18
@je-cook je-cook self-assigned this Sep 10, 2024
@je-cook je-cook added documentation Improvements or additions to documentation build_stage labels Sep 10, 2024
Copy link

codecov bot commented Sep 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.37%. Comparing base (3567a3b) to head (ddf39fb).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3599      +/-   ##
===========================================
- Coverage    76.38%   76.37%   -0.02%     
===========================================
  Files          230      230              
  Lines        26647    26655       +8     
===========================================
+ Hits         20355    20358       +3     
- Misses        6292     6297       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@je-cook je-cook closed this Sep 10, 2024
auto-merge was automatically disabled September 10, 2024 12:41

Pull request was closed

@je-cook je-cook reopened this Sep 10, 2024
@je-cook je-cook enabled auto-merge (squash) September 10, 2024 12:41
Copy link

sonarcloud bot commented Sep 10, 2024

@je-cook je-cook merged commit 95df6c6 into develop Sep 10, 2024
18 checks passed
@je-cook je-cook deleted the ocean/pc-cryostat-DOC201 branch September 10, 2024 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build_stage documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add parameter descriptions for CryostatBuilderParams
2 participants