docs: Update and extend HAL API documentation after HAL module updates#4080
Merged
Conversation
Sigma1912
reviewed
May 30, 2026
BsAtHome
force-pushed
the
fix_doc-hal-updates
branch
from
b38c896 to
6e11044
Compare
Contributor
Author
You become blind to your own typos when staring at a text too long. Good that you are looking. |
Contributor
|
Can one of you change their avatar? I thought Bertho was talking to himself 🤦 |
Contributor
Author
I'm always talking to myself... Where is the problem? |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This completes API doc for the current HAL implementation in the python HAL module (after the module got updated). All classes, including streams and ports, are now fully documented.
It will be changed again with the getter/setter implementation, but the outline is now describing the full API as implemented.