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
Improve the documentation of dataverse #116
Conversation
❌ Deploy Preview for theatrejs-playground failed.
|
3e1c946
to
233b1f9
Compare
233b1f9
to
5052c07
Compare
This PR is intended to be production-ready. 😊 |
> Note that all the changes of the derivations' values inside the callback | ||
> function (first argument of `usePrism()`) will be tracked, since `usePrism()` | ||
> uses the `prism()` function under the hood. However, if the derivations are | ||
> not provided in the dependency array of `usePrism()`, then it will not know if |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say "If the prism uses a value that is not a derivation (such as a simple number, or a pointer), then you need to provide that value to the dependency array.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, that does sound more clear. I'll change this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is where the change got implemented: #116 (comment)
></div> | ||
</> | ||
) | ||
}, [panelB]) // Note that `panelB` is in the dependency array |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this example, panelB
never changes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yepp, but isn't it good practice to include it in the dependency array anyways? It is mentioned later that panelB
can be omitted from the dependency array.
How about |
Good suggestions, I'll include them! |
1919fc2
to
b92f732
Compare
second argument. If the prism uses a value that is not a derivation (such as a | ||
simple number, or a pointer), then you need to provide that value to the | ||
dependency array. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AriaMinaei This is the place where I put the change you suggested in this comment
These are the things that are included in the guide right now (source): @AriaMinaei Do you miss anything? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM :)
Objectives
Get started guide