Skip to content

docs: Update and extend HAL API documentation after HAL module updates#4080

Open
BsAtHome wants to merge 1 commit into
LinuxCNC:masterfrom
BsAtHome:fix_doc-hal-updates
Open

docs: Update and extend HAL API documentation after HAL module updates#4080
BsAtHome wants to merge 1 commit into
LinuxCNC:masterfrom
BsAtHome:fix_doc-hal-updates

Conversation

@BsAtHome
Copy link
Copy Markdown
Contributor

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.

Copy link
Copy Markdown
Contributor

@Sigma1912 Sigma1912 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a small one

Comment thread docs/src/config/python-hal-interface.adoc
Copy link
Copy Markdown
Contributor

@Sigma1912 Sigma1912 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some spelling nits

Comment thread docs/src/config/python-hal-interface.adoc Outdated
Comment thread docs/src/config/python-hal-interface.adoc Outdated
@BsAtHome BsAtHome force-pushed the fix_doc-hal-updates branch from b38c896 to 6e11044 Compare May 30, 2026 15:53
@BsAtHome
Copy link
Copy Markdown
Contributor Author

some spelling nits

You become blind to your own typos when staring at a text too long. Good that you are looking.

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.

2 participants