All: Modules in potential need of documentation

Aperta
#367 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
jquery
Ambito
documentation

Direzione di ricerca

Inizia esaminando il boilerplate della documentazione e la gestione esistente del gruppo exclude descritta nell’issue, usando il modulo core come esempio. Chiarisci quali moduli elencati necessitano di documentazione o demo e quali dovrebbero essere esclusi. Il lavoro è completato quando le decisioni sono registrate e i moduli interessati producono i metadati della documentazione previsti oppure vengono nascosti in modo coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
HTML
Stelle
55
Fork
57
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di jquery/api.jquerymobile.com

Tutte le issue di jquery/api.jquerymobile.com

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.