Inconsistency in react docs
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 11.8k
- Forks
- 7.9k
- Ø Merge
- 1 T. 11 Std.
- Gemergte PRs (30 T.)
- 11
Beschreibung
I wanted to open an issue some days ago about some inconsistencies I found in the documentation of react, today I saw again and saw most of them were fixed as the image below. In API REFERENCE import sections is now as:
in other sections it was in plain text. The only section which still has plain text is React Top-Level API, I am not sure if it should be modified at least from "If you use ES6 with npm, you can write import React from..." as the other sections has.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der verlinkten React Top-Level API-Seite und vergleiche deren Import-Hinweise mit den anderen im Issue gezeigten API-Referenzabschnitten. Bestätige die Dokumentationskonvention und aktualisiere anschließend die verbleibenden Klartext-Hinweise, falls angemessen; abgeschlossen ist die Aufgabe, wenn die Importabschnitte eine einheitliche Formulierung und Formatierung verwenden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, react
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100