search

lbr-stack / pyfri

KUKA Fast Robot Interface Python SDK.
https://lbr-stack.readthedocs.io/en/latest/pyfri/doc/pyfri.html
Apache License 2.0
22 stars 3 forks source link

Improve Documentation #15

Closed CameronDevine closed 2 months ago

CameronDevine commented 7 months ago

As part of the JOSS review (openjournals/joss-reviews#6138) API documentation is required. I am finding some documentation in the Readme, and some in the Wiki, but I don't believe this is sufficient. Looking at the examples, there are a lot of methods that are not documented.

mhubii commented 5 months ago

I agree, the pyFRI is rather a weak-spot of this submission. We will have to make some improvements here. Thank you for pointing this out

adi3 commented 4 months ago

@mhubii see if using Komment helps you get this through.

mhubii commented 4 months ago

I'd love to try that. Would you have any hints for getting started?

mhubii commented 4 months ago

okay wow that was quite easy. Tested on a single file, created a PR

https://github.com/lbr-stack/pyFRI/pull/16

This does seem to support Python right now?

mhubii commented 2 months ago

added documentation for examples, and the overall software architecture. Referred to in-depth KUKA documentation for the FRI, as these are just bindings.