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

Web Components: Document the TypeScript type definition .d.ts support #4988

Closed
RobertaJHahn opened this issue Jan 22, 2021 · 0 comments
Closed

Web Components: Document the TypeScript type definition .d.ts support #4988

RobertaJHahn opened this issue Jan 22, 2021 · 0 comments
Assignees
@asudoh
Labels
dev Needs some dev work documentation Improvements or additions to documentation package: web components Work necessary for the IBM.com Library web components package
Milestone
Sprint 21-03

Comments

@RobertaJHahn
Copy link

RobertaJHahn commented Jan 22, 2021 •
edited by asudoh
Loading

The problem

TypeScript type definition support of @carbon/ibmdotcom-web-components has some new technical approaches in its implementation details.

The solution

Document them so new developers can easily jump into the codebase.
@RobertaJHahn RobertaJHahn added dev Needs some dev work documentation Improvements or additions to documentation package: web components Work necessary for the IBM.com Library web components package labels Jan 22, 2021
@asudoh asudoh self-assigned this Jan 28, 2021
@asudoh asudoh added this to the Sprint 21-03 milestone Jan 28, 2021
asudoh added a commit to asudoh/ibm-dotcom-library that referenced this issue Jan 28, 2021
@asudoh
docs(web-components): add notes on TypeScript definition files
035bada 
Adds implementation notes for TypeScript definition files in
`@carbon/ibmdotcom-web-components` so that new developers can quickly
understand the difference from regular NPM packages.

Refs carbon-design-system#4988.
@asudoh asudoh mentioned this issue Feb 1, 2021
Merged
kodiakhq bot pushed a commit that referenced this issue Feb 2, 2021
@asudoh
docs(web-components): add notes on TypeScript definition files (#5044)
2c70a97 
### Related Ticket(s)

Refs #4988.

### Description

Adds implementation notes for TypeScript definition files in `@carbon/ibmdotcom-web-components` so that new developers can quickly understand the difference from regular NPM packages.

### Changelog

**New**

- Implementation notes for TypeScript definition files in `@carbon/ibmdotcom-web-components`.
IgnacioBecerra pushed a commit to IgnacioBecerra/ibm-dotcom-library that referenced this issue Feb 22, 2021
@asudoh @IgnacioBecerra
docs(web-components): add notes on TypeScript definition files (carbo…
6d53ec7 
…n-design-system#5044)

### Related Ticket(s)

Refs carbon-design-system#4988.

### Description

Adds implementation notes for TypeScript definition files in `@carbon/ibmdotcom-web-components` so that new developers can quickly understand the difference from regular NPM packages.

### Changelog

**New**

- Implementation notes for TypeScript definition files in `@carbon/ibmdotcom-web-components`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@asudoh asudoh

Labels
dev Needs some dev work documentation Improvements or additions to documentation package: web components Work necessary for the IBM.com Library web components package
Projects
None yet
Milestone
Sprint 21-03
Development

No branches or pull requests
2 participants
@asudoh @RobertaJHahn