shawnbot/topogram

Comment Example Doesn't Have Correct Number of Variables

Open

#16 opened on Sep 5, 2014

View on GitHub
 (6 comments) (0 reactions) (0 assignees)HTML (321 stars) (133 forks)batch import
help wanted

Description

In the commented out example of how to use the code it only refers to topology (and not also the geometry) variable:

  • var features = cartogram(topology);

Contributor guide

Tech stack
javascript
Domain
frontenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScript knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Locate the commented example in the repository's main JavaScript file (e.g., src/topogram.js). Update the example to include the missing 'geometry' variable so it matches the actual function signature. The current line `// var features = cartogram(topology);` should become `// var features = cartogram(topology, geometry);`. Verify there are no other inconsistencies in the comment.