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

Add better documentation for parameter vs. input function names #420

Open
dannys4 opened this issue May 14, 2024 · 0 comments
Open

Add better documentation for parameter vs. input function names #420

dannys4 opened this issue May 14, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@dannys4
Copy link
Contributor

dannys4 commented May 14, 2024

In light of #301, we should document what Gradient versus CoeffGrad means as well as other things.

I think a good idea would be to create some kind of "cheat sheet" or "quick reference" or something of that sort which explains things well and link it at the top of the documentation, and then link the appropriate API references therein.

@dannys4 dannys4 added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 14, 2024
@dannys4 dannys4 modified the milestones: v3, v3.1 May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant