Update api.md to include missing modules and functions #104
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.
Update API Documentation
This PR updates the
api.md
file to include documentation for modules and functions that were missing from the documentation but exist in the implementation.Added Documentation for Missing Modules
binary_helpers.py
: Helper methods for binary transferscobs.py
: Functions for COBS encoding and decodingcrc32.py
: Functions for computing CRC32 checksumsgpio.py
: GPIO abstractions for different platformsmd5.py
: Functions for computing MD5 hashestimeout.py
: Functions for managing timeoutstransaction_manager.py
: Classes for managing Notecard transactionsAdded Documentation for Missing Functions
card.transport
: Configure the Notecard's connectivity methodnotecard.GetUserAgent
: Returns the User Agent String for the hostnotecard.SetAppUserAgent
: Sets the User Agent info for the appnotecard.UserAgentSent
: Returns true if the User Agent has been sentnotecard.SetTransactionPins
: Sets the pins used for RTX and CTXUpdated Documentation for Functions with Missing Parameters
note.template
: Added missingport
andcompact
parametersLink to Devin run: https://app.devin.ai/sessions/fd01c8097736469f9edc331366d54b3d
Requested by: [email protected]