Add information on documenting directives
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 142
- Forks
- 230
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
We don't currently have any guidelines around documenting elements or directives. Might be something like this:
## Documenting directives
To add API documentation to directives, we recommend adding a doc comment on the directive function:
```ts
/**
* Renders a placeholder message until `promise` resolves, then renders the
* value of the fulfilled promise.
* @param promise A promise that yields a value to render
*/
export const resolvePromise = directive(ResolvePromise);
```
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Finde den passenden Dokumentationsabschnitt im lit.dev-Repository für Hinweise zur directive API. Verwende den vorgeschlagenen Inhalt und das Beispiel „Documenting directives“ als Ausgangspunkt; abgeschlossen ist die Aufgabe, wenn veröffentlichte Hinweise Dokumentationskommentare und die Dokumentation von Parametern für directives erläutern.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100