Python-Wrapper Documentation #103
Merged
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
Signed-off-by: Kevin Vu te Laar <[email protected]>
stv0g
requested changes
Mar 13, 2025
There was a problem hiding this comment.
I left some initial comments, but overall I think the quality of the page is not yet up to par to be included in the VILLASnode documentation.
This needs to be improved. It also focuses far to much on development internals and should be written with users in mind.
docs/node/clients/python_wrapper.md
Outdated
| @@ -0,0 +1,931 @@ | |||
| # Python-Wrapper Documentation: | |||
|
|
|||
| >Important Preface: | |||
There was a problem hiding this comment.
Please use a Docusaurus Admonitions.
docs/node/clients/python_wrapper.md
Outdated
| 6. [Installation](#6.-installation) | ||
|
|
||
| ## 1. VILLASnode functions exposed by the C-API | ||
| ``` |
There was a problem hiding this comment.
Please at the proper language to all code-blocks:
Suggested change
| ``` | |
| ```c |
docs/node/clients/python_wrapper.md
Outdated
| # Python-Wrapper Documentation: | ||
|
|
||
| >Important Preface: | ||
| All of the documentation and testing done regarding the VILLASnode Python-Wrapper |
There was a problem hiding this comment.
Suggested change
| All of the documentation and testing done regarding the VILLASnode Python-Wrapper | |
| All of the documentation and testing done regarding the VILLASnode Python-wrapper |
docs/node/clients/python_wrapper.md
Outdated
|
|
||
| >Important Preface: | ||
| All of the documentation and testing done regarding the VILLASnode Python-Wrapper | ||
| is based upon the signal_v2 node provided by VILLASnode. |
There was a problem hiding this comment.
Suggested change
| is based upon the signal_v2 node provided by VILLASnode. | |
| is based upon the `signal_v2` node-type provided by VILLASnode. |
docs/node/clients/python_wrapper.md
Outdated
| const char *node_to_json_str(vnode *n); | ||
| unsigned sample_length(vsample *smp); | ||
|
|
||
| #Functions related to data transfer |
There was a problem hiding this comment.
Suggested change
| #Functions related to data transfer | |
| # Functions related to data transfer |
docs/node/clients/python_wrapper.md
Outdated
|
|
||
| ## 1. VILLASnode functions exposed by the C-API | ||
| ``` | ||
| #Functions to set up up a node or modify its state |
There was a problem hiding this comment.
Suggested change
| #Functions to set up up a node or modify its state | |
| # Functions to set up up a node or modify its state |
docs/node/clients/python_wrapper.md
Outdated
| 5. [Contributing to the Python-Wrapper](#5.-contributing-to-the-python-wrapper) | ||
| 6. [Installation](#6.-installation) | ||
|
|
||
| ## 1. VILLASnode functions exposed by the C-API |
There was a problem hiding this comment.
Can we link to the actual header from the VILLASnode repo here?
E.g: https://github.com/VILLASframework/node/blob/master/include/villas/node.h
docs/node/clients/python_wrapper.md
Outdated
| 2. Build VILLASnode from source [as is described here](../installation.md) and make sure to have all of the necessary | ||
| dependencies installed. | ||
|
|
||
| **The requirements for the Python-Wrapper differ from the Versions listed in 2.** |
There was a problem hiding this comment.
Suggested change
| **The requirements for the Python-Wrapper differ from the Versions listed in 2.** | |
| **The requirements for the Python-Wrapper differ from the versions listed in 2.** |
docs/node/clients/python_wrapper.md
Outdated
| This is where Pybind11 has the advantage of being a header only library, essentially being Macros that directly use the Python C API. This gives you more direct control as for how your code works and interacts with C/C++/Python. | ||
| Especially Pybind11 being the more lightweight solution, considering dependencies, installation and integration, makes it more favorable to use. | ||
|
|
||
| --- |
There was a problem hiding this comment.
Are the horizontal lines necessary? Its breaking consistency with other pages.
docs/node/clients/python_wrapper.md
Outdated
| ... | ||
| } | ||
|
|
||
| #C-API of VILLASnode called by the node_start() binding |
There was a problem hiding this comment.
Suggested change
| #C-API of VILLASnode called by the node_start() binding | |
| # C-API of VILLASnode called by the node_start() binding |
Implemented suggested changes. Removed dev related documentation/information. Changed the documentation to be user centric. Signed-off-by: Kevin Vu te Laar <[email protected]>
KeVteL
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Documentation is now user centric.
Changes that could and may should be made:
More detailed installation documentation.
Maybe provide Distro specific instructions (including package/dependency names) or installation scripts,
such as a PKGBUILD file for Arch Linux (as an example).