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(components): [select] use new display tag #13301

Merged
merged 3 commits into from
Aug 21, 2023

Conversation

wzc520pyfm
Copy link
Contributor

@wzc520pyfm wzc520pyfm commented Jun 20, 2023

Related: #10754

Please make sure these boxes are checked before submitting your PR, thank you!

  • Make sure you follow contributing guide English | (中文 | Español | Français).
  • Make sure you are merging your commits to dev branch.
  • Add some descriptions and refer to relative issues for your PR.

Description

🤖 Generated by Copilot at e8caf41

This pull request updates the documentation and comments of the Select component and its subcomponents (Option and Option Group) in element-plus. It adds type information, descriptions and consistency for the attributes, events, slots and methods of the components, and removes some deprecated or unused attributes. The purpose of this pull request is to improve the readability and usability of the documentation and code for developers and users.

Related Issue

Fixes #___.

Explanation of Changes

🤖 Generated by Copilot at e8caf41

  • Update the documentation of the Select component in docs/en-US/component/select.md to use a more consistent and informative format and add type information (link)
  • Add description comments for the props of the Option Group, Option and Select components in packages/components/select/src (link, link, link)

@pull-request-triage
Copy link

👋 @wzc520pyfm, thank you for contributing element-plus.

  • You can comment with /label Components:[component_name] to add a label for which component you are working on.
  • You may join our Discord for staying tuned.

@github-actions
Copy link

Hello @wzc520pyfm, thank you for contributing to element-plus, please see our guideline to see how to make contribution

@github-actions
Copy link

github-actions bot commented Jun 20, 2023

@github-actions
Copy link

github-actions bot commented Jun 20, 2023

🧪 Playground Preview: https://element-plus.run/?pr=13301
Please comment the example via this playground if needed.

@wzc520pyfm wzc520pyfm requested a review from btea July 2, 2023 11:33
docs/en-US/component/select.md Outdated Show resolved Hide resolved
docs/en-US/component/select.md Outdated Show resolved Hide resolved
@btea btea merged commit 37f40dc into element-plus:dev Aug 21, 2023
10 checks passed
laizuan pushed a commit to laizuan/element-plus that referenced this pull request Sep 5, 2023
* docs(components): [select] use new display tag

* docs(components): [select] description and comment begins in lower case

* docs(components): [select] update type of prop and event
consultation-applio pushed a commit to consultation-applio/element-plus that referenced this pull request Nov 10, 2023
* docs(components): [select] use new display tag

* docs(components): [select] description and comment begins in lower case

* docs(components): [select] update type of prop and event
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants