pyfri icon indicating copy to clipboard operation
pyfri copied to clipboard

Published 20 hours ago • verified publisher icon lbr-stack

Improve Documentation

Open CameronDevine opened this issue 1 year ago • 4 comments

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.

CameronDevine avatar Apr 13 '24 18:04 CameronDevine

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

mhubii avatar Jun 12 '24 10:06 mhubii

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

adi3 avatar Jul 03 '24 10:07 adi3

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

mhubii avatar Jul 03 '24 15:07 mhubii

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 avatar Jul 03 '24 15:07 mhubii

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

mhubii avatar Sep 08 '24 16:09 mhubii