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

Fetching accounts is not sufficiently documented #545

Open
mitschabaude opened this issue Jul 31, 2023 · 2 comments
Open

Fetching accounts is not sufficiently documented #545

mitschabaude opened this issue Jul 31, 2023 · 2 comments
Labels
bug Something isn't working docs Improvements or additions to documentation

Comments

@mitschabaude
Copy link
Contributor

mitschabaude commented Jul 31, 2023

For example, the fetchAccount() function is not mentioned

@barriebyron barriebyron added bug Something isn't working docs Improvements or additions to documentation labels Jul 31, 2023
@barriebyron
Copy link
Contributor

auto-generated docs for https://docs.minaprotocol.com/zkapps/snarkyjs-reference/modules/Mina#getaccount
are we missing auto-gen docs for fetchAccount()?

@mitschabaude
Copy link
Contributor Author

auto-generated docs for https://docs.minaprotocol.com/zkapps/snarkyjs-reference/modules/Mina#getaccount are we missing auto-gen docs for fetchAccount()?

We do miss auto-generated docs for this, but I also think these aren't sufficient in this case. Auto-generated docs are useful as a reference to learn the precise usage of a method / class you already know, but they're not useful to introduce a method, because we shouldn't expect people to click through the entire API reference just to find out what is available

@garwalsh garwalsh added to-burn and removed to-burn labels Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants