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

[all] Expand jsdoc documentation #1883

Open
aomarks opened this issue May 12, 2021 · 1 comment
Open

[all] Expand jsdoc documentation #1883

aomarks opened this issue May 12, 2021 · 1 comment
Assignees
@bicknellr @AndrewJakubowicz
Milestone
Lit 2.1

Comments

@aomarks
Copy link
Member

aomarks commented May 12, 2021

The jsdoc documentation for all the core libraries are currently very lacking, as can be seen by browsing through https://lit.dev/docs/api/LitElement/ and related pages.

We should sweep through every API and a whole bunch of missing documentation.
@justinfagnani justinfagnani added this to the Lit RC.next milestone Aug 20, 2021
@justinfagnani justinfagnani modified the milestones: Lit RC.4, Lit RC.5 Sep 2, 2021
This was referenced Sep 15, 2021
Merged
Merged
@justinfagnani justinfagnani modified the milestones: Lit 2.0, Lit 2.1 Sep 21, 2021
@AndrewJakubowicz
Copy link
Contributor

AndrewJakubowicz commented Jan 21, 2022 •
edited

Note the list below was generated from the lit.dev API docs. There may be some duplication.

Usage: Check off audited identifiers. If a PR improved the documentation please link to the PR.

Publicly generated JSDoc symbols to audit/improve (top level):

LitElement

  • LitElement - /packages/lit-element/src/lit-element.ts#L86
  • RenderOptions - /packages/lit-html/src/lit-html.ts#L375

ReactiveElement

Templates

Styles

Decorators

Directives

Custom Directives

Static HTML

  • html - /packages/lit-html/src/static.ts#L133
  • literal - /packages/lit-html/src/static.ts#L55
  • svg - /packages/lit-html/src/static.ts#L141
  • unsafeStatic - /packages/lit-html/src/static.ts#L26
  • withStatic - /packages/lit-html/src/static.ts#L72

Controllers

Misc

@AndrewJakubowicz AndrewJakubowicz mentioned this issue Jan 21, 2022
Closed
@aomarks aomarks removed their assignment Jan 24, 2022
This was referenced Jan 26, 2022
Merged
Merged
@AndrewJakubowicz AndrewJakubowicz mentioned this issue May 9, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bicknellr bicknellr

@AndrewJakubowicz AndrewJakubowicz

Labels
None yet
Projects
Lit Project Board
Status: ⏱ In Progress
Milestone
Lit 2.1
Development

No branches or pull requests
4 participants
@aomarks @bicknellr @justinfagnani @AndrewJakubowicz