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

docs: Improve documentation for database objects #109

Merged
merged 2 commits into from
Jan 26, 2025

Conversation

bvanelli
Copy link
Owner

@bvanelli bvanelli commented Jan 26, 2025

Improves documentation on many fields, including:

  • Explain that bold transactions cannot be achieved via this API
  • Add a docstring to most useful database tables
  • Document table methods so that they appear on the documentation
  • Add one basic example using relationships and properties, using the budget as an example

Closes #105
Closes #107

Copy link

codecov bot commented Jan 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.90%. Comparing base (b3df262) to head (71ae5fa).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #109   +/-   ##
=======================================
  Coverage   97.90%   97.90%           
=======================================
  Files          16       16           
  Lines        2295     2295           
=======================================
  Hits         2247     2247           
  Misses         48       48           

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

@bvanelli bvanelli changed the title docs: Improve documentation docs: Improve documentation for database objects Jan 26, 2025
@bvanelli bvanelli merged commit 8ded923 into main Jan 26, 2025
9 checks passed
@bvanelli bvanelli deleted the 105-improve-balances-documentation branch January 26, 2025 17:18
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.

New transactions show as bold? Improve documentation on balances
1 participant