Add proper error description in tutorial
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
URL: https://reactjs.org/tutorial/tutorial.html
In the Lifting State Up we reach a point where we have passed the onClick handler of square from board and we are about to define the handleClick() function and the guide states that for now we will get an error as this.handleClick is not a function
whereas I receive a slightly different error. (enclosed in screenshots)
It would benefit the tutorial to add a screenshot so that the user running through the tutorial is getting the correct type of error.
this might seem excessive but when a person is following a guide step by step even a mention of receiving a planned error seems like a step in the learning and hence we should ensure the user gets a better look at it.
I am just putting this here as maybe a discussion point or if any mod could provide some insight
(doesn't seem like a major fix and would love to send a PR for this as well, if we decide to implement this)
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.
Research direction
Review the React tutorial's "Lifting State Up" section at the linked tutorial URL and compare the documented this.handleClick error with the screenshots in the issue. Update the explanation or add the requested screenshot so the expected error matches what users encounter; verify the tutorial still reads correctly from the preceding step.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100