ember-learn / ember-learn/ember-cli-addon-docs

Document inheritance in component subclasses

Aperta
#1,316 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
JavaScript
Stelle
172
Fork
142
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

I'm using ember-cli-typescript to develop an addon. My components subclass a base component. I'd really like the documentation to show the inherited pieces of the base component.

Given that the default documenter is YUIDocs and that it's purely tag driven, that doesn't seem possible. Is this done with ember component projects or is this a pipe dream?

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Non vengono indicati file, test o punti di ingresso. Inizia tracciando il modo in cui il documentatore YUIDocs predefinito in ember-cli-addon-docs gestisce le sottoclassi dei componenti, quindi determina se è possibile rappresentare gli elementi ereditati da un componente di base; il lavoro è completato quando la documentazione generata mostra tali elementi ereditati.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.