Skip to content
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

[docs] Generate templates entries about documented generics #7851

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

LukasTy
Copy link
Member

@LukasTy LukasTy commented Feb 7, 2023

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

@LukasTy LukasTy added the docs Improvements or additions to the documentation label Feb 7, 2023
@LukasTy LukasTy self-assigned this Feb 7, 2023
@mui-bot
Copy link

mui-bot commented Feb 7, 2023

Messages
📖 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 🚫 dangerJS against 29280b1

Copy link
Member

@flaviendelangle flaviendelangle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Other than that, I'm curious to see feedback from the other teams on the core PR.
It feels better than today, even if we are far from something perfect.

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

@LukasTy
Copy link
Member Author

LukasTy commented Feb 8, 2023

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.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 23, 2023
@github-actions
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation PR: out-of-date The pull request has merge conflicts and can't be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants