All: Modules in potential need of documentation

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

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
20/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
jquery

Línea de trabajo

Comienza revisando la plantilla base de la documentación y el manejo existente del grupo exclude descrito en el issue, usando el módulo core como ejemplo. Aclara qué módulos de la lista necesitan documentación o demos y cuáles deberían excluirse. Se considera terminado cuando las decisiones estén registradas y los módulos afectados produzcan los metadatos de documentación previstos o se oculten de forma coherente.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

As I'm implementing the boilerplate for our library, I'm finding that I cannot produce a "docs" metadata field for some of our modules. Here are those we may (not) want to document/demo:

  • zoom
  • animationComplete
  • navigation/base (do we even need it anymore? https://github.com/jquery/jquery-mobile/issues/7489)
  • navigation/path (needs demos - maybe?)
  • widgets/controlgroup.backcompat (needs if ( $.mobileBackcompat ))
  • slider tooltip API (option popupEnabled and showValue)
  • textarea autogrow has no demo
  • $.mobile.iosorientationfixEnabled needs to be documented in global options (also, demo?)
  • accordion - docs and demos
  • support - do we want docs/demos?

Can we use the "exclude" group to hide modules in the DB? I've encountered

//>>group: exclude

For example, our core, which is merely a bundling of other modules, is labelled thus.

Lenguaje dominante
HTML
Estrellas
55
Forks
57
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

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.

Más de jquery/api.jquerymobile.com

Todos los issues de jquery/api.jquerymobile.com

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.