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

Add module docstrings #12

Merged
merged 8 commits into from
Sep 11, 2024
Merged

Add module docstrings #12

merged 8 commits into from
Sep 11, 2024

Conversation

kelly-sovacool
Copy link
Member

@kelly-sovacool kelly-sovacool commented Sep 11, 2024

Changes

Add minimal module docstrings

Also move template-related functions to the templates module

Issues

NA

PR Checklist

(Strikethrough any points that are not applicable.)

  • This comment contains a description of changes with justifications, with any relevant issues linked.
  • Write unit tests for any new features, bug fixes, or other code changes.
  • Update docs if there are any API changes.
  • Update CHANGELOG.md with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/

Copy link

codecov bot commented Sep 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 29.92%. Comparing base (9725718) to head (e27b9c0).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #12      +/-   ##
==========================================
- Coverage   35.37%   29.92%   -5.46%     
==========================================
  Files          13       17       +4     
  Lines        1046     1260     +214     
==========================================
+ Hits          370      377       +7     
- Misses        676      883     +207     

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

@kelly-sovacool kelly-sovacool marked this pull request as ready for review September 11, 2024 16:43
@kelly-sovacool kelly-sovacool merged commit b24ecb9 into main Sep 11, 2024
6 of 7 checks passed
@kelly-sovacool kelly-sovacool deleted the docs-updates branch September 11, 2024 16:43
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.

1 participant