Add information on documenting directives
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 142
- Forks
- 230
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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);
```
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Trouvez la section de documentation appropriée dans le dépôt lit.dev pour les conseils sur la directive API. Utilisez le contenu et l’exemple proposés « Documenting directives » comme point de départ ; le travail sera terminé lorsque la documentation publiée expliquera les commentaires de documentation et la documentation des paramètres pour les directives.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100