-
Notifications
You must be signed in to change notification settings - Fork 10
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
AI generated documentation for Nox #11
Comments
Hey @nestordemeure, we're certainly open to it but it depends heavily on the quality of the generated comments. Could we start with a small submodule and then review it? My general preference for code comments is to not be overly verbose wrt. information that can easily be inferred from the function signature. Comments that explain complex/unintuitive behavior are the most welcome. |
Do you have a submodule you would recommend? I could then make a PR to have comments to discuss. |
Could you try on the |
Will do and keep you posted once the PR is up :) |
I think the |
1 PR for the rest of the module is fine, and somewhat preferable. Reviewing it isn't a concern. |
I have added a PR covering the full Nox library. That was a lot of comments and will definitely take some time to review but it looks like an acceptable basis to document the code. |
Thanks! Will try review it today or tomorrow. |
Hi!
Would you be interested in a PR adding AI-generated documentation to the types, traits, and functions in Nox? It would be manually checked by a human (me) who has knowledge of Jax and Rust but not this particular codebase.
I have run some quick tests and the output seem serviceable, definitely not perfect but a good starting point to be tweaked by people familiar with the codebase before merging.
The text was updated successfully, but these errors were encountered: