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

fix(docs): add documentation regarding the carbonElement decorator #10871

Merged
merged 5 commits into from
Aug 29, 2023
Merged

fix(docs): add documentation regarding the carbonElement decorator #10871

merged 5 commits into from
Aug 29, 2023

Conversation

pjudge
Copy link
Contributor

@pjudge pjudge commented Aug 23, 2023 •
edited
Loading

Related Ticket(s)

Closes #10278

Description

This PR updates documentation to include information on the @carbonElement decorator and its usage. This will help ensure contributors use the decorator correctly and understand its purpose.

Changelog

New

  • Added a 'Custom Elements' heading to documentation; added information about @carbonElement decorator in a subheading to that.

@ibmdotcom-bot
Copy link
Contributor

ibmdotcom-bot commented Aug 23, 2023 •
edited
Loading

Deploy preview created for package React:
https://ibmdotcom-react.s3.us-south.cloud-object-storage.appdomain.cloud/deploy-previews/10871/index.html

Built with commit: 85fb7d2ff475959d52aa77c7630d347c1c2e97da

@ibmdotcom-bot
Copy link
Contributor

ibmdotcom-bot commented Aug 23, 2023 •
edited
Loading

Deploy preview created for package Carbon Web Components:
https://carbon-web-components.s3.us-east.cloud-object-storage.appdomain.cloud/deploy-previews/10871/index.html

Built with commit: 85fb7d2ff475959d52aa77c7630d347c1c2e97da

@ibmdotcom-bot
Copy link
Contributor

ibmdotcom-bot commented Aug 23, 2023 •
edited
Loading

Deploy preview created for package Web Components:
https://ibmdotcom-webcomponents.s3.us-east.cloud-object-storage.appdomain.cloud/deploy-previews/10871/index.html

Built with commit: 85fb7d2ff475959d52aa77c7630d347c1c2e97da

@ibmdotcom-bot
Copy link
Contributor

ibmdotcom-bot commented Aug 23, 2023 •
edited
Loading

Deploy preview created for package Web Components (React wrapper):
https://ibmdotcom-web-components-react.s3-web.us-east.cloud-object-storage.appdomain.cloud/deploy-previews/10871/index.html

Built with commit: 85fb7d2ff475959d52aa77c7630d347c1c2e97da

@pjudge @jkaeser
Update packages/web-components/docs/coding-conventions.md
6567188 
Co-authored-by: John Kaeser <jakaeser44@gmail.com>
@pjudge pjudge marked this pull request as ready for review August 23, 2023 16:33
@pjudge pjudge requested a review from a team as a code owner August 23, 2023 16:33
@pjudge pjudge requested a review from andy-blum August 23, 2023 17:05
@kennylam kennylam added the Ready to merge Label for the pull requests that are ready to merge label Aug 25, 2023
@kodiakhq kodiakhq bot merged commit 883a7e5 into carbon-design-system:main Aug 29, 2023
23 of 25 checks passed
m4olivei pushed a commit to m4olivei/carbon-for-ibm-dotcom that referenced this pull request Aug 31, 2023
@pjudge @m4olivei
fix(docs): add documentation regarding the carbonElement decorator (c…
6d52908 
…arbon-design-system#10871)

### Related Ticket(s)

Closes carbon-design-system#10278 

### Description

This PR updates documentation to include information on the `@carbonElement` decorator and its usage. This will help ensure contributors use the decorator correctly and understand its purpose. 

### Changelog

**New**

- Added a 'Custom Elements' heading to documentation; added information about `@carbonElement` decorator in a subheading to that.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andy-blum andy-blum andy-blum approved these changes

@jkaeser jkaeser jkaeser approved these changes

@kennylam kennylam kennylam approved these changes

@emyarod emyarod Awaiting requested review from emyarod emyarod is a code owner automatically assigned from carbon-design-system/carbon-for-ibm-com-members

@annawen1 annawen1 Awaiting requested review from annawen1 annawen1 is a code owner automatically assigned from carbon-design-system/carbon-for-ibm-com-members

Assignees
No one assigned
Labels
Ready to merge Label for the pull requests that are ready to merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[CarbonElement]: Update tests and/or documentation
5 participants
@pjudge @ibmdotcom-bot @kennylam @jkaeser @andy-blum