reactjs / reactjs/react-docgen

Flow's @platform attribute treated as part of the description

Ouverte
#447 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
TypeScript
Étoiles
3.8k
Forks
316
Merge moyen
5 h 7 min
PR mergées (30 j)
4

Description

See: React Native Button.js

/**
   * TV next focus down (see documentation for the View component).
   *
   * @platform android
   */
  nextFocusDown?: ?number,

gets captured as:

"nextFocusDown": {
        "required": false,
        "flowType": {
          "name": "number",
          "nullable": true
        },
        "description": "TV next focus down (see documentation for the View component).\n\n@platform android"

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par reproduire l’extraction à partir de l’exemple Button.js de React Native, puis suivez la façon dont le bloc de documentation Flow est analysé. C’est terminé lorsque l’annotation @platform android n’est plus incluse dans la description de la propriété et que le résultat extrait correspond au comportement attendu des métadonnées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
react-native
Domaine
documentation, tooling
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.