bitovi / bitovi/canjs.com

#each helper needs better documentation

Open Beginner friendly
#170 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
17
Forks
12
PR merge metrics
No merged PRs in 30d

Description

The [current documentation](http://canjs.com/docs/can.Mustache.helpers.each.html) for the Mustache `{{#each}}` helper doesn't seem to talk about why it is different from the simple Mustache iteration (in that it removes and adds elements to a list dynamically and provides @key and @index directives).

Contributor guide

Open the contributing guide

Research direction

Start with the current Mustache #each documentation at http://canjs.com/docs/can.Mustache.helpers.each.html and compare it with the simple Mustache iteration behavior described elsewhere in the project. Update the documentation to explain dynamic list additions and removals and the @key and @index directives; done means these differences are clearly covered on the page.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.