Doku options types
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 321
- Forks
- 195
- PR merge metrics
- No merged PRs in 30d
Description
look at the `options.types.line`. It should be: `options.types.polyline`
current:
``` js
var options = {
folder: 'myshapes',
types: {
point: 'mypoints',
polygon: 'mypolygons',
line: 'mylines'
}
}
```
correct:
``` js
var options = {
folder: 'myshapes',
types: {
point: 'mypoints',
polygon: 'mypolygons',
polyline: 'mypolylines'
}
}
```
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
Search the documentation for the `options.types.line` example and inspect the surrounding options reference. Update the documented key and value to use `polyline` and `mypolylines`, then verify the example no longer refers to `line`.
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
- 52/100