styleguidist/react-styleguidist

Ignore doctag doesn't work with TypeScript

Open

#830 ouverte le 18 févr. 2018

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)TypeScript (1 416 forks)github user discovery
bughelp wanted

Métriques du dépôt

Stars
 (11 091 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

    "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.

Guide contributeur

Direction de recherche
Enquêtez pour savoir pourquoi la balise @ignore n'est pas respectée par react docgen typescript. Vérifiez si la balise est correctement analysée et s'il existe des filtres qui devraient exclure les propriétés ignorées.
Stack technique
typescript
Domaine
tooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitNode.jsTypeScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70