Add information on documenting directives
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 142
- Forks
- 230
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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);
```
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Encuentra la sección de documentación adecuada en el repositorio lit.dev para obtener orientación sobre la directive API. Usa como punto de partida el contenido y el ejemplo propuestos “Documenting directives”; la tarea estará terminada cuando la documentación publicada explique los comentarios de documentación y la documentación de parámetros para directives.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100