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

Improve sdk documentation #711

Merged
merged 4 commits into from
Jun 27, 2024
Merged

Conversation

nroggeman-ledger
Copy link
Contributor

Description

The goal of this PR is to improve the SDK generated documentation:

  • fix warnings
  • update NBGL Use Case user manual
  • automatically generate documentation in GitHub

Changes include

  • Bugfix (non-breaking change that solves an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (change that is not backwards-compatible and/or changes current functionality)
  • Tests
  • [*] Documentation
  • Other (for changes that might not fit in any category)

@codecov-commenter
Copy link

codecov-commenter commented Jun 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.19%. Comparing base (dfb10c1) to head (f1656b5).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #711   +/-   ##
=======================================
  Coverage   60.19%   60.19%           
=======================================
  Files          12       12           
  Lines        1726     1726           
=======================================
  Hits         1039     1039           
  Misses        687      687           
Flag Coverage Δ
unittests 60.19% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@cedelavergne-ledger
Copy link
Contributor

If I am correct, this PR replaces #478

@nroggeman-ledger nroggeman-ledger merged commit 9145aa6 into master Jun 27, 2024
193 of 194 checks passed
@nroggeman-ledger nroggeman-ledger deleted the improve-sdk-documentation branch June 27, 2024 13:41
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.

3 participants