lit / lit/lit.dev

Add information on documenting directives

Abierto
#167 0 comentarios 0 reacciones 0 asignados Ver en GitHub

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

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. 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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.