docs2 icon indicating copy to clipboard operation
docs2 copied to clipboard

Fetching accounts is not sufficiently documented

Open mitschabaude opened this issue 1 year ago • 2 comments

For example, the fetchAccount() function is not mentioned

mitschabaude avatar Jul 31 '23 06:07 mitschabaude

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

barriebyron avatar Jul 31 '23 13:07 barriebyron

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

mitschabaude avatar Jul 31 '23 14:07 mitschabaude