docs: add reference to applyAccept from upload()
#1144
Conversation
✅ Deploy Preview for testing-library ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
docs/user-event/api-utility.mdx
Outdated
| Files that don't match an `accept` property will be automatically discarded, | ||
| unless [`applyAccept`](options.mdx#applyaccept) is set to `false`. |
There was a problem hiding this comment.
Suggestion: can we add this in an Admonitions?
| Files that don't match an `accept` property will be automatically discarded, | |
| unless [`applyAccept`](options.mdx#applyaccept) is set to `false`. | |
| :::info | |
| Files that don't match an `accept` property will be automatically discarded, | |
| unless [`applyAccept`](options.mdx#applyaccept) is set to `false`. | |
| ::: |
There was a problem hiding this comment.
We can, but I don't see it being used anywhere in the User Interactions area. Instead, I see quoting (>) is being used to mark notes (example), likely being the less visually-intrusive alternative. I can convert it to admonition, to a quote or just leave it as is - the decision would happen between you and @ph-fritsche , I guess.
There was a problem hiding this comment.
Actually, now that I've seen it on the preview website it looks good.
The reason why I mentioned it was because I would see myself looking at the docs exactly because files might be discarded and I wanted to know why. Hence, I thought it would be better that it would stand out. But it looks good now already.
@ph-fritsche you got the final say here :)
There was a problem hiding this comment.
I would make this a new paragraph. The other sections start with a very short description of what the API does. Often just the name of the API used in a proper sentence.
This might not make for the best novel read, but it is easy to follow when skim reading.
The admonitions stick out. I'd reserve them for information that doesn't "fit in the story" but is too important to be just placed somewhere else.
But I'm fine with it either way.
There was a problem hiding this comment.
I agree with what I read above - people will come to see the docs "exactly because files might be discarded", so the note should be "easy to follow when skim reading", but not "stick out". I think quoting makes the best balance, and it is already extensively used in the other paragraphs of the same file. I've made the adjustment, LMK if that looks better. I'm happy to tweak it further if needed.
|
@all-contributors please add @khitrenovich for docs |
|
I've put up a pull request to add @khitrenovich! 🎉 |
See testing-library/user-event#1046 (comment) for related discussion.