reactjs / reactjs/react.dev

🚫** (Warns in development) is open to interpretation

Offen
#2,701 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

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

My colleagues and I were discussing this section of the docs and got a bit confused:

https://reactjs.org/docs/concurrent-mode-adoption.html#feature-comparison

Screenshot 2020-01-23 at 12 28 05

It was not 100% clear whether 🚫** → Warns in development means

  • works, may be buggy, warns in development
    or
  • does not work, also warns in development.

Both interpretations can be explained logically. The first one can be true because the footer note does explicitly say does not work and we're still in 16.x, which assumes no breaking changs. The second interpretation comes from the presence of 🚫.

I'm wondering if the docs could be improved by replacing 🚫* and 🚫** with distinct emojis (e.g. ⚠️, ⛔️, 🚨, 🤞, ✳️, 🆗, ❇️, etc.). Each emoji can be present in a footnote, including ✅ and 🚫.

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

Beginnen Sie mit dem Abschnitt Feature Comparison unter der verlinkten URL concurrent-mode-adoption.html und prüfen Sie die Legende, Fußnoten und den Screenshot zu 🚫* und 🚫**. Klären Sie den Unterschied zwischen unterstützt-aber-mit-Warnung-Verhalten und nicht unterstütztem Verhalten und überprüfen Sie anschließend, dass die überarbeiteten Symbole und Erklärungen in der Dokumentation klar dargestellt werden.

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
48/100

Neue Issues direkt in Ihr Postfach

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