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 TODOs across animal module code. #475

Merged
merged 2 commits into from
Jul 1, 2024

Conversation

TaranRallings
Copy link
Collaborator

Description

It was suggested that I should be turning my TODOs into issues and that I should be making branches out of those issues. To begin this process I needed to clean up my TODOs and that is what I have done here.

The TODOs are now much better organized and they have been made into issues. There were a couple little docstring updates I did along the way when I realized something was out of date.

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

@TaranRallings TaranRallings linked an issue Jun 28, 2024 that may be closed by this pull request
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.96%. Comparing base (11df335) to head (61f2ee0).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #475   +/-   ##
========================================
  Coverage    94.96%   94.96%           
========================================
  Files           70       70           
  Lines         3792     3792           
========================================
  Hits          3601     3601           
  Misses         191      191           

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

Copy link
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!

Copy link
Collaborator

@dalonsoa dalonsoa left a comment

Choose a reason for hiding this comment

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

Fantastic!

Rather than creating issues with an "Animal - ..." title, I think it will be useful to use labels to classify the issues by categories or themes. That way is also easier to filter or quickly visualise what the issues you have are about. So, I would create a label for Animal, another for Plats, etc. and use those.

@TaranRallings TaranRallings merged commit f11dd73 into develop Jul 1, 2024
12 checks passed
@TaranRallings TaranRallings deleted the 461-animal-model-housekeeping branch July 1, 2024 10:00
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.

Animal Model Housekeeping
4 participants