lit / lit/lit.dev

[docs/api] Directives documentations start with the ancestor class' description.

Open
#1,289 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
142
Forks
230
PR merge metrics
No merged PRs in 30d

Description

Directives which extend `Directive` class has the same

> Base class for creating custom directives. Users should extend this class, implement render and/or update, and then pass their subclass to directive.

description.

Directives which extend `AsyncDirective` class has the same

> An abstract `Directive` base class whose `disconnected` method will be called when the part containing the directive is cleared as a result of re-rendering, or when the user calls `part.setConnected(false)` on a part that was previously rendered containing the directive (as happens when e.g. a LitElement disconnects from the DOM).

description

[Directives page](https://lit.dev/docs/api/directives/)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked Directives API page and compare the generated descriptions for Directive and AsyncDirective with their documented subclasses. Trace how those descriptions are sourced, then update the documentation so each subclass starts with its own description rather than the ancestor text. Done means the Directives page shows the correct descriptions for both classes.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.