reactjs / reactjs/react-docgen

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

Offen
#447 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
3.8k
Forks
316
Ø Merge
5 Std. 7 Min.
Gemergte PRs (30 T.)
4

Beschreibung

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"

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Extraktion aus dem React Native Button.js-Beispiel zu reproduzieren, und verfolge dann, wie der Flow-Dokumentationsblock geparst wird. Fertig ist die Aufgabe, wenn die Annotation @platform android nicht mehr in der Beschreibung der Eigenschaft enthalten ist und das extrahierte Ergebnis dem beabsichtigten Metadatenverhalten entspricht.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react-native
Bereich
documentation, tooling
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.