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

[TreeView][lab] Fix JSDoc comments in TreeView and TreeItem #38874

Merged
merged 3 commits into from
Sep 25, 2023

Conversation

jergason
Copy link
Contributor

@jergason jergason commented Sep 9, 2023

Update the JSDoc comment to point folks to the @mui/x-tree-view package instead of @mui/x-date-pickers.

@mui-bot
Copy link

mui-bot commented Sep 9, 2023

Netlify deploy preview

https://deploy-preview-38874--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 7a5a22f

@zannager zannager added the package: lab Specific to @mui/lab label Sep 11, 2023
@zannager zannager requested a review from mnajdova September 11, 2023 10:53
Copy link
Member

@ZeeshanTamboli ZeeshanTamboli left a comment

Choose a reason for hiding this comment

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

@jergason Thanks for the fix! Could you also update it in the Tree Item file?

--- a/packages/mui-lab/src/TreeItem/TreeItem.tsx
+++ b/packages/mui-lab/src/TreeItem/TreeItem.tsx
@@ -23,7 +23,7 @@ const warn = () => {
 };

 /**
- * @deprecated The TreeItem component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this mi
gration on our blog: https://mui.com/blog/lab-tree-view-to-mui-x/.
+ * @deprecated The TreeItem component was moved from `@mui/lab` to `@mui/x-tree-view`. More information about this migra
tion on our blog: https://mui.com/blog/lab-tree-view-to-mui-x/.
  * @ignore - do not document.
  */
 const TreeItem = React.forwardRef(function DeprecatedTreeItem(

Additionally, please merge with the latest master branch.

packages/mui-lab/src/TreeView/TreeView.tsx Outdated Show resolved Hide resolved
@ZeeshanTamboli ZeeshanTamboli changed the title [lab] update treeview jsdoc comment [TreeView][lab] Fix TreeView and TreeItem JSDoc comments Sep 25, 2023
@ZeeshanTamboli ZeeshanTamboli added bug 🐛 Something doesn't work docs Improvements or additions to the documentation component: tree view TreeView, TreeItem. This is the name of the generic UI component, not the React module! labels Sep 25, 2023
@ZeeshanTamboli
Copy link
Member

ZeeshanTamboli commented Sep 25, 2023

@jergason Thanks for the fix! Could you also update it in the Tree Item file?

--- a/packages/mui-lab/src/TreeItem/TreeItem.tsx
+++ b/packages/mui-lab/src/TreeItem/TreeItem.tsx
@@ -23,7 +23,7 @@ const warn = () => {
 };

 /**
- * @deprecated The TreeItem component was moved from `@mui/lab` to `@mui/x-date-pickers`. More information about this mi
gration on our blog: https://mui.com/blog/lab-tree-view-to-mui-x/.
+ * @deprecated The TreeItem component was moved from `@mui/lab` to `@mui/x-tree-view`. More information about this migra
tion on our blog: https://mui.com/blog/lab-tree-view-to-mui-x/.
  * @ignore - do not document.
  */
 const TreeItem = React.forwardRef(function DeprecatedTreeItem(

Additionally, please merge with the latest master branch.

I fixed this. I was not able to push on your branch so I had added this comment, but now I could.

@ZeeshanTamboli ZeeshanTamboli changed the title [TreeView][lab] Fix TreeView and TreeItem JSDoc comments [TreeView][lab] Fix JSDoc comments in TreeView and TreeItem Sep 25, 2023
Copy link
Member

@ZeeshanTamboli ZeeshanTamboli left a comment

Choose a reason for hiding this comment

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

Thank you!

@ZeeshanTamboli ZeeshanTamboli merged commit 14ae9d3 into mui:master Sep 25, 2023
6 checks passed
mnajdova pushed a commit to mnajdova/material-ui that referenced this pull request Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something doesn't work component: tree view TreeView, TreeItem. This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation package: lab Specific to @mui/lab
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants