Variable naming inconsistency in the tutorial documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- javascript, react
- Domain
- documentation
Research direction
Start with content/tutorial/tutorial.md and read the tutorial's render function alongside jumpTo to confirm the variable naming inconsistency. Check the linked CodePen to determine whether it is also part of the requested documentation change. Done means the tutorial uses consistent names and the relevant example remains understandable to beginners.
Written by the indexing model from the issue text.
Description
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:
But jumpTo use step to make the moves:
I suggest that we switch the move and step variables of the render function to make the tutorial more understandable by beginners:
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?
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 16h 6m
- Merged PRs (30d)
- 7
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from reactjs/react.dev
-
type: documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
bug: unconfirmed
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
type: typos
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
bug: unconfirmed
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
All issues in reactjs/react.dev
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·