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.

Sign up for GitHub

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

Jump to bottom

[core] Remove unnecessary syntax from JS Docs #10568

Closed
Lev-Shapiro opened this issue Oct 3, 2023 · 1 comment · Fixed by #10567
Closed

[core] Remove unnecessary syntax from JS Docs #10568

Lev-Shapiro opened this issue Oct 3, 2023 · 1 comment · Fixed by #10567
Labels
component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature

Comments

@Lev-Shapiro
Copy link
Contributor

Lev-Shapiro commented Oct 3, 2023 •
edited by oliviertassinari
Loading

Related page

JS Documentation

Kind of issue

Other

Issue description

I've found that for no reason ( I guess ) in JS Docs there were couple of times at which after the @default keyword there was a colon symbol which isn't required by syntax of JS docs and has absolutely no purpose ( additionally it looks ugly ). so it should be removed I guess

Context 🔦

Screenshot 2023-10-11 at 00 21 35

Search keywords: Docs, docs syntax
@Lev-Shapiro Lev-Shapiro added status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Oct 3, 2023
@Lev-Shapiro
Copy link
Contributor Author

#10567 that PR solves this

@Lev-Shapiro Lev-Shapiro mentioned this issue Oct 3, 2023
Merged
1 task
@LukasTy LukasTy changed the title [docs] Remove unnecessary syntax from JS Docs [core] Remove unnecessary syntax from JS Docs Oct 4, 2023
@LukasTy LukasTy added core Infrastructure work going on behind the scenes component: data grid This is the name of the generic UI component, not the React module! enhancement This is not a bug, nor a new feature and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Oct 4, 2023
@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation and removed core Infrastructure work going on behind the scenes labels Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DataGrid] Remove unnecessary syntax in JSDoc Lev-Shapiro/mui-x
3 participants
@oliviertassinari @LukasTy @Lev-Shapiro