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.

Sign up for GitHub

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

Jump to bottom

Adding automodule hooks for plants model to docs #380

Merged
merged 2 commits into from
Feb 5, 2024
Merged

Adding automodule hooks for plants model to docs #380

merged 2 commits into from
Feb 5, 2024

Conversation

davidorme
Copy link
Collaborator

Description

This PR adds missing autodoc hooks for the models/plants docstrings.

Fixes #379

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

@davidorme davidorme linked an issue Feb 5, 2024 that may be closed by this pull request
PlantsModel missing API documentation hooks #379
Closed
jacobcook1995
jacobcook1995 approved these changes Feb 5, 2024
View reviewed changes
Copy link
Collaborator

@jacobcook1995 jacobcook1995 left a comment

Choose a reason for hiding this comment

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

LGTM! Only thing I noticed was a typo

@davidorme davidorme merged commit 24b49fd into develop Feb 5, 2024
16 checks passed
@davidorme davidorme deleted the 379-plantsmodel-missing-api-documentation-hooks branch February 5, 2024 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jacobcook1995 jacobcook1995 jacobcook1995 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

PlantsModel missing API documentation hooks
2 participants
@davidorme @jacobcook1995