inconsistent parameter handling
Open
Nobody has claimed this yet.
Area:Core
Bug
- Dominant language
- JavaScript
- Stars
- 24k
- Forks
- 3.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 25
Description
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)
p5.js version
web version
Web browser and version
124.0
Operating system
OSX
Steps to reproduce this
documentation in general would highly benefit from traditional parameter notation;
e.g.
"Stroke(color)
Stroke(color, alpha)
Stroke(r, g, b)
Stroke(r, g, b, alpha)
Stroke(rgb)
Stroke(rgb, alpha) < this one I tried and it broke
"
is this a javascript thing?
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 by reviewing the p5.js web documentation for the Stroke() parameter signatures and reproduce the reported Stroke(rgb, alpha) case in the web version. Clarify whether the request concerns documentation notation, parameter handling, or both; done means the intended signatures and behavior are consistent and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100