Document Option That Can Be Passed to react-test-renderer's create Function
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
Currently in the docs for TestRenderer.create, it mentions the function takes an options argument: https://reactjs.org/docs/test-renderer.html#testrenderercreate
It doesn't mention what options are actually allowed unless you scroll to the very end in a section titled "Ideas", which is not intuitive at all.
The allowed options should be documented at the create function's documentation location instead.
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 im Issue verlinkten Dokumentation zu TestRenderer.create und überprüfe die Optionen, die derzeit im späteren Abschnitt „Ideas“ beschrieben werden. Verschiebe die Erklärung der zulässigen Optionen an die Dokumentationsstelle der create-Funktion oder dupliziere sie dort. Bestätige anschließend, dass die Optionen dort auffindbar sind, ohne zu diesem Abschnitt scrollen zu müssen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, react
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 45/100