Improve documentation for NBGL module #308
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
yogh333
force-pushed
the
y333/improve_doc_nbgl
branch
from
03ee009 to
8991b7c
Compare
yogh333
had a problem deploying
to
github-pages
GitHub Actions
Failure
yogh333
had a problem deploying
to
github-pages
GitHub Actions
Failure
yogh333
force-pushed
the
y333/improve_doc_nbgl
branch
from
62c4bc2 to
fcd2e5f
Compare
yogh333
requested review from
fbeutin-ledger,
iartemov-ledger and
tdejoigny-ledger
| @@ -1,3 +1,14 @@ | |||
| //! A wrapper around the asynchronous NBGL [nbgl_useCaseAdvancedReview](https://github.com/LedgerHQ/ledger-secure-sdk/blob/f7ba831fc72257d282060f9944644ef43b6b8e30/lib_nbgl/src/nbgl_use_case.c#L3957) C API binding. | |||
There was a problem hiding this comment.
Should not we just use the short url, https://github.com/LedgerHQ/ledger-secure-sdk/blob/master/lib_nbgl/src/nbgl_use_case.c#L4370 , here and in all other places ?
| QRCodeWarning, | ||
| BarListWarning, | ||
| } | ||
| // pub enum WarningDetailsType { |
There was a problem hiding this comment.
Maybe then to remove completely ?
| } | ||
|
|
||
| /// Structure exposed by the NBGL Rust API to the user to create a | ||
| /// Structure exposed by the NBGL Rust API to the user to create as |
There was a problem hiding this comment.
I believe this is yet a.
| - name: Cargo doc | ||
| run: | | ||
| cargo doc -p ledger_device_sdk --no-deps --lib --target flex | ||
| cargo doc -p ledger_device_sdk --no-deps --lib |
There was a problem hiding this comment.
There are 73 " missing documentation" warnings shown by rustdoc linter.
Probably to fix incrementally.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.