jotai icon indicating copy to clipboard operation
jotai copied to clipboard

[useAtomDevtools]: documentation for `DevtoolOptions`

Open pondorasti opened this issue 2 years ago • 2 comments

PR#1095 introduced a new way to call useAtomDevtools hook and label atoms using DevtoolOptions object. From that point forward, making debug labels the old fashioned way useAtomDevtools(atom, "name") started throwing console warnings.

What's the timeline for fully deprecating and removing old method? I would also love to see updated docs for usage, which I could help with 🙃 👀 .

CleanShot 2022-05-23 at 17 20 12

pondorasti avatar May 24 '22 00:05 pondorasti

PR#1095 introduced a new way to call useAtomDevtools hook and label atoms using DevtoolOptions object. From that point forward, making debug labels the old fashioned way useAtomDevtools(atom, "name") started throwing console warnings.

Right. Sorry about the confusion.

What's the timeline for fully deprecating and removing old method?

No planned timeline, but we should eventually remove deprecated method.

I would also love to see updated docs for usage, which I could help with 🙃 👀 .

That's very appreciated. One of the biggest things to improve currently is docs. There are some work going on. If you can take the devtools part, it's more than welcomed.

dai-shi avatar May 24 '22 00:05 dai-shi

Cool cool, I will try to find some time this week and submit a draft for /devtools page.

pondorasti avatar May 24 '22 04:05 pondorasti

Is it stalled?

dai-shi avatar Nov 03 '22 23:11 dai-shi

Some minors clarifications have been already made to devtools docs by others. Unfortunately, as jotai couldn't satisfy some project requirements, I had to move away to a different framework and lost familiarity/context :/

pondorasti avatar Nov 15 '22 03:11 pondorasti

No problem. Closing.

dai-shi avatar Nov 15 '22 04:11 dai-shi