reactjs / reactjs/react.dev

Variable naming inconsistency in the tutorial documentation

Offen Anfängerfreundlich
#4,823 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

Hi,
I have just used the React tutorial, it is great!
It helps a lot to learn the basic.

While working, I have spotted a small inconsistency on https://github.com/reactjs/reactjs.org/blob/main/content/tutorial/tutorial.md

When creating the buttons to move into the history, we are using a move variable that we are sending to jumpTo:

image

But jumpTo use step to make the moves:

image

I suggest that we switch the move and step variables of the render function to make the tutorial more understandable by beginners:

image

I can push a merge request for the documentation but I do not know how to change the source code linked by @gaearon on codepen:
https://codepen.io/gaearon/pen/gWWZgR?editors=0010

Is there a way to do that?

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 mit content/tutorial/tutorial.md und lies die render-Funktion des Tutorials zusammen mit jumpTo, um die Inkonsistenz bei der Variablenbenennung zu bestätigen. Prüfe den verlinkten CodePen, um festzustellen, ob er ebenfalls Teil der angeforderten Dokumentationsänderung ist. Erledigt ist die Aufgabe, wenn das Tutorial konsistente Namen verwendet und das relevante Beispiel für Anfänger verständlich bleibt.

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

Neue Issues direkt in Ihr Postfach

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