mui-x icon indicating copy to clipboard operation
mui-x copied to clipboard

[docs] Generate `templates` entries about documented generics

Open LukasTy opened this issue 2 years ago • 3 comments

Requires changes from https://github.com/mui/material-ui/pull/36097 to use the defined templates and output their descriptions in documentation (title on the generic name).

LukasTy avatar Feb 07 '23 16:02 LukasTy

Messages
:book: Netlify deploy preview: https://deploy-preview-7851--material-ui-x.netlify.app/

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 602.8 916.2 654.5 717.5 123.222
Sort 100k rows ms 565.3 1,048.9 780.5 826.54 157.231
Select 100k rows ms 197 294.8 224.1 231.82 33.393
Deselect 100k rows ms 132.1 296.4 199 206.82 56.019

Generated by :no_entry_sign: dangerJS against 29280b1e910aec4381718f0cf0dd450d31de5bc6

mui-bot avatar Feb 07 '23 16:02 mui-bot

Do you think the word template is easy enough to understand ? TValue is a generic, I think all the templates we are using describes generics (but that's maybe not a absolute rule though).

Oh no, I'm definitively not sure about the templates name, that's why I'd like to hear feedback from others. 🙈 Generics does seem like a decent option, but might also cause a bit of confusion to someone without typed language experience. 🤔


For example, the value prop has an any typing, when it should be TDate | null (with the ability to know what TDate is).

Indeed, we could definitely improve the value prop typing and make it more a bit clear with the help of this added documentation.

LukasTy avatar Feb 08 '23 10:02 LukasTy

This pull request has conflicts, please resolve those before we can evaluate the pull request.

github-actions[bot] avatar Feb 23 '23 11:02 github-actions[bot]