[utils] Add documentation to useForkRef
#44410
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JCQuintas
added
docs
Netlify deploy previewhttps://deploy-preview-44410--material-ui.netlify.app/ Bundle size report |
oliviertassinari
added
package: base-ui
|
Fair enough. Per https://www.notion.so/mui-org/engineering-mui-utils-purpose-9a9fc9da3a004864b6c4e1f4d1f24f95?p=6af37c204f624505b8ef6b1fb571366a we likely want to keep it private cc @michaldudak, but having some docs for developer internally is cool 👍. |
|
Yeah, my goal was more for internal use, as I was using it by "copy/paste" and I had to go to the source to understand what it does exactly. This small doc should help future "me"s 😆 |
|
@JCQuintas I pushed the docs a bit further #44424, I was a bit confused with what I read. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation to explain what the
useForkRefactually does and is useful for.