max-mapper / max-mapper/javascript-for-cats

Suggestion for clarity: 1 -> a

Open
#38 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
794
Forks
139
PR merge metrics
No merged PRs in 30d

Description

In the "Loops" section, when introducing the _.times function it would be more clear to say:

This code uses the times method of Underscore which takes in a number and a function and then starts from 0 and for 10 steps counts up by 1, calling the function with the number each step of the way.

than

This code uses the times method of Underscore which takes in 1 number and 1 function and then starts from 0 and for 10 steps counts up by 1, calling the function with the number each step of the way.

because numbers (0, 10, and 1) are used immediately after and that juxtaposition is a bit confusing.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the Loops section and find the explanation introducing Underscore's _.times function. Replace the wording that says it takes “1 number and 1 function” with the suggested wording, then verify that the surrounding examples still read clearly.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.