-
Notifications
You must be signed in to change notification settings - Fork 7.6k
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
Add Experimental Taint API Docs #6337
Conversation
Size changes📦 Next.js Bundle Analysis for react-devThis analysis was generated by the Next.js Bundle Analysis action. 🤖 One Page Changed SizeThe following page changed size from the code in this PR compared to its base branch:
DetailsOnly the gzipped size is provided here based on an expert tip. First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If Any third party scripts you have added directly to your app using the Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 10% or more, there will be a red status indicator applied, indicating that special attention should be given to 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 great! Thank you for doing this. This makes a huge difference in being able to document these APIs early. You writing the initial docs takes so much back and forth out of the equation, and makes write the docs so much more pleasant!
I did a quick pass and added some thoughts. I'm also happy to take this PR over and make the changes I suggested if you like.
Another general thought: We should probably add this to the ToC with some kind of label like canary to indicate this is an experimental API (but I can do this after the fact if you like)
src/content/reference/react/experimental_taintObjectReference.md
Outdated
Show resolved
Hide resolved
src/content/reference/react/experimental_taintObjectReference.md
Outdated
Show resolved
Hide resolved
Yea, please take it over with whatever change you'd like. |
src/content/reference/react/experimental_taintObjectReference.md
Outdated
Show resolved
Hide resolved
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. Left some nits.
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.
Might need to go in a separate PR but we should change the API ordering to sort based on the first letter of the string after experimental_
This will help keep the order stable when the experimental prefix is removed and make it clearer where to find the API when you only know it by it's semantic name, "taint" for instance
alternatively consider putting all experimental references at the end of the list
Good note. I'll add the experimental APIs at the end of the list for now. |
Did you want to mention that the value taint lives through the end of a request? |
The way it's described is in terms of the reverse, that it only gets promoted if the object outlives the request.
Not sure the intricacies are important for knowing how it's used. It might be important if you're vetting the implementation details but you should probably assume it works as described otherwise. |
These are still experimental. I haven't linked to them from anywhere yet.
Previews: