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

Fix docs formatting (bullet points, etc) #334

Merged
merged 5 commits into from Dec 12, 2022
Merged

Fix docs formatting (bullet points, etc) #334

merged 5 commits into from Dec 12, 2022

Conversation

joseph-robertson
Copy link
Contributor

Fixes #333

Pull Request Description

description here

Checklist

Not all may apply

  • Code changes (must work)
  • Tests exercising your feature/bug fix (check coverage report on Checks -> BuildStockBatch Tests -> Artifacts)
  • Coverage has increased or at least not decreased. Update minimum_coverage in .github/workflows/ci.yml as necessary.
  • All other unit tests passing
  • Update validation for project config yaml file changes
  • Update existing documentation
  • Run a small batch run to make sure it all works (local is fine, unless an Eagle specific feature)
  • Add to the changelog_dev.rst file and propose migration text in the pull request

@joseph-robertson joseph-robertson added the bug Something isn't working label Dec 7, 2022
@joseph-robertson joseph-robertson self-assigned this Dec 7, 2022
@github-actions
Copy link

github-actions bot commented Dec 7, 2022

File Coverage
All files 86%
base.py 88%
eagle.py 74%
exc.py 57%
localdocker.py 63%
postprocessing.py 84%
utils.py 96%
sampler/base.py 79%
sampler/downselect.py 33%
sampler/precomputed.py 93%
sampler/residential_quota.py 83%
test/test_validation.py 96%
workflow_generator/base.py 90%
workflow_generator/commercial.py 53%
workflow_generator/residential.py 96%
workflow_generator/residential_hpxml.py 70%

Minimum allowed coverage is 33%

Generated by 🐒 cobertura-action against 3b897de

@joseph-robertson joseph-robertson marked this pull request as ready for review December 7, 2022 18:21
Copy link
Member

@nmerket nmerket left a comment

Choose a reason for hiding this comment

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

Confirmed. It looks good in the generated docs. Can you add a quick entry to the changelog?

@nmerket nmerket merged commit 654a41b into develop Dec 12, 2022
@nmerket nmerket deleted the docs-bullets branch December 12, 2022 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix docs formatting (bullet points, etc)
2 participants