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

Move pyrealm_build_data documentation into an autodoc style setup #331

Conversation

davidorme
Copy link
Collaborator

Description

This PR moves all of the text out of the existing pyrealm_build_data.md file and into appropriate __init__.py docstrings within the pyrealm_build_data package. It then adds autodoc directives to pull those docstrings back into the same file. This keeps the package documentation actually within the package.

The PR also removes a couple of outdated files and adds some missing documentation.

Fixes #271

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 Oct 16, 2024 that may be closed by this pull request
@davidorme davidorme requested a review from j-emberton October 16, 2024 16:59
@codecov-commenter
Copy link

codecov-commenter commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.70%. Comparing base (1f315ba) to head (1d5fc6f).
Report is 209 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #331      +/-   ##
===========================================
+ Coverage    95.29%   95.70%   +0.41%     
===========================================
  Files           28       34       +6     
  Lines         1720     2469     +749     
===========================================
+ Hits          1639     2363     +724     
- Misses          81      106      +25     

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

@j-emberton
Copy link
Collaborator

Created issue #332 to document need to clean up two leaf build data as noted in init.py

Copy link
Collaborator

@j-emberton j-emberton left a comment

Choose a reason for hiding this comment

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

This looks good to me. I've added an issue to capture need to work on 'two leaf' build docs. We might want to add another issue to capture note on updating uk data links to publicly accessible sources but I'm happy to leave that up to you.

@j-emberton j-emberton assigned j-emberton and davidorme and unassigned j-emberton Oct 17, 2024
@davidorme davidorme merged commit 396c553 into develop Oct 17, 2024
12 checks passed
@davidorme davidorme deleted the 271-move-pyrealm_build_data-documentation-into-an-autodoc-style-setup branch October 17, 2024 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Move pyrealm_build_data documentation into an autodoc style setup.
3 participants