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.

Sign up for GitHub

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

Jump to bottom

Add Reference documentation to docs #6505

Open

4 tasks

jzaki opened this issue May 17, 2024 · 0 comments

Assignees

Contributor

jzaki commented May 17, 2024

Context: Auto-generated reference documentation is not so informative since there are few significant code comments that surface.

Task:

Shortlist initial set of valuable references
Add comments to important functions
- Any low-hanging fruit functions on the way
Confirm/fix instances of code/doc differences (eg self), missing types, ...

The text was updated successfully, but these errors were encountered:

jzaki self-assigned this

jzaki mentioned this issue

Add Reference documentation to docs #6506

Closed

4 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment