processing / processing/processing-website
Parameters for `vertex()` too confusing.
Open
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 90
- Forks
- 122
- Avg merge
- 1h 43m
- Merged PRs (30d)
- 3
Description
Issue description
The parameters are too confusing! v has two meanings.
URL(s) of affected page(s)
https://processing.org/reference/vertex_.html
Proposed fix
Please replace vertex(v) with something like vertex(a), then state that a is a float[].
Contributor guide
No contributing guide indexed for this repository
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
Open the affected vertex() reference page at the URL and locate the parameter description and signature. Update the confusing parameter naming and state that the array parameter is a float[]; the page should clearly explain the meaning of each parameter afterward.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100