styleguidist/react-styleguidist

Ignore doctag doesn't work with TypeScript

Open

#830 geöffnet am 18. Feb. 2018

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (1.416 Forks)github user discovery
bughelp wanted

Repository-Metriken

Stars
 (11.091 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

    "react-styleguidist": "^6.2.5",
    "react-docgen-typescript": "^1.2.3",

using

export interface RoleProps {
    /** 
     * @ignore 
     */
    css?: M.Styling.CSSProperties
    /** @ignore */
    dontappear?: string;
} 

Both appear in the generated Styleguide.

Contributor Guide

Research-Richtung
Untersuchen Sie, warum das @ignore Tag von react docgen typescript nicht beachtet wird. Prüfen Sie, ob das Tag korrekt geparst wird und ob es Filter gibt, die ignorierte Eigenschaften ausschließen sollten.
Tech Stack
typescript
Domain
tooling
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitNode.jsTypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70