Calculation map() Documentation Enhancement
Open
Nobody has claimed this yet.
Area:Math
Discussion
Enhancement
- Dominant language
- JavaScript
- Stars
- 24k
- Forks
- 3.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 25
Description
Increasing access
No
Most appropriate sub-area of p5.js?
- Accessibility
- Color
- Core/Environment/Rendering
- Data
- DOM
- Events
- Image
- IO
- Math
- Typography
- Utilities
- WebGL
- Build process
- Unit testing
- Internationalization
- Friendly errors
- Other (specify if possible)
- Documentation
- Calculation
Feature enhancement details
I'd like to propose specifying in the documentation that map() preforms a linear mapping: https://p5js.org/reference/p5/map/
I'd also add a recommendation to use manual mappings for different needs.
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
Start at the p5.js map() reference page linked in the issue and inspect its current documentation. Update it to state that map() performs a linear mapping and recommend manual mappings for other needs; the work is done when both points are clearly documented.
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