Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation #15

Closed
CameronDevine opened this issue Apr 13, 2024 · 5 comments
Closed

Improve Documentation #15

CameronDevine opened this issue Apr 13, 2024 · 5 comments
Assignees

Comments

@CameronDevine
Copy link

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
Copy link
Member

mhubii commented Jun 12, 2024

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
Copy link

adi3 commented Jul 3, 2024

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

@mhubii
Copy link
Member

mhubii commented Jul 3, 2024

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

@mhubii
Copy link
Member

mhubii commented Jul 3, 2024

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

#16

This does seem to support Python right now?

mhubii added a commit that referenced this issue Sep 7, 2024
@mhubii mhubii self-assigned this Sep 7, 2024
This was referenced Sep 7, 2024
@mhubii
Copy link
Member

mhubii commented Sep 8, 2024

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

@mhubii mhubii closed this as completed Sep 8, 2024
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

No branches or pull requests

3 participants