Skip to content

Animal docs update#634

Merged
TaranRallings merged 7 commits intodevelopfrom
animal-docs-update
Dec 11, 2024
Merged

Animal docs update#634
TaranRallings merged 7 commits intodevelopfrom
animal-docs-update

Conversation

@TaranRallings
Copy link
Copy Markdown
Collaborator

Description

This is a basic update of the animal docs to get the basic ideas and implementation structure across. My main goal with this docs update is to provide something folks who see our poster at BES this week. This is time sensitive so I would like to get it up asap and I am happy to make revisions after the fact.

Fixes # (issue)

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist

  • Make sure you've run the pre-commit checks: $ pre-commit run -a
  • All tests pass: $ poetry run pytest

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works
  • Relevant documentation reviewed and updated

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Dec 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.69%. Comparing base (15352ab) to head (1a90ce3).
Report is 1018 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #634   +/-   ##
========================================
  Coverage    94.69%   94.69%           
========================================
  Files           73       73           
  Lines         4582     4582           
========================================
  Hits          4339     4339           
  Misses         243      243           

☔ 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.

Copy link
Copy Markdown
Collaborator

@vgro vgro left a comment

Choose a reason for hiding this comment

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

Looks very good to me, very clear and well structured. I think it is the perfect level of detail for the current status of the model and will be very useful for people who check out the model at this stage.

Copy link
Copy Markdown
Collaborator

@davidorme davidorme left a comment

Choose a reason for hiding this comment

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

LGTM - some minor nitpicks.

TaranRallings and others added 4 commits December 11, 2024 11:17
…tion.md

Co-authored-by: David Orme <davidorme@users.noreply.github.com>
…tion.md

Co-authored-by: David Orme <davidorme@users.noreply.github.com>
…tion.md

Co-authored-by: David Orme <davidorme@users.noreply.github.com>
@TaranRallings TaranRallings merged commit 48ec0ff into develop Dec 11, 2024
@TaranRallings TaranRallings deleted the animal-docs-update branch December 11, 2024 13:07
@TaranRallings TaranRallings restored the animal-docs-update branch December 11, 2024 13:24
@TaranRallings TaranRallings deleted the animal-docs-update branch December 11, 2024 13:37
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.

4 participants