max-mapper / max-mapper/javascript-for-cats
Reduce Confusion
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 794
- Forks
- 139
- PR merge metrics
- No merged PRs in 30d
Description
Hi
Thx for this awesome tute. As a noob, i appreciate the introduction. Suggestion: in the section on callbacks, you repeatedly go back and forth between blocking and non-blocking. To me, this is very confusing. I'd find it easier to understand if you separated your statements about blocking from your statements about non-blocking, like this:
In the blocking version a and b are both called/invoked (they both have () after them which executes the functions immediately). In the blocking version, there is no explicit relationship between a and b.
In the non-blocking version b is a callback to a. In the non-blocking version you will notice that only a gets invoked, and b is simply passed in to a as an argument. In the non-blocking version it becomes a's job to do what it needs to do and then call b when it is done.
Contributor guide
No contributing guide indexed for this repository
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
Open the tutorial's callbacks section and compare its blocking and non-blocking explanations with the suggested separation in this issue. Revise the section so the two cases are discussed separately, then verify that the callback relationship and invocation behavior remain clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100