processing / processing/processing-website
Docs for scale
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 90
- Forks
- 122
- Avg merge
- 1h 43m
- Merged PRs (30d)
- 3
Description
Issue description
The documentation of scale says:
"For example, the function call scale(2.0) increases the dimension of a shape by 200%."
This is unfortunately a mistake. Let's say the unit of the x-axis before the scaling is 10,
then after it is 2*10=20. The growth is 20-10=10. Which amounts to 100%.
Scaling with s gives in general a growth of s-1.
Now it not just the sentence above that needs a change: the parameters s, x and y
are described as "percentages". This should be changed to "scalar" or "factor" or similar.
URL(s) of affected page(s)
https://processing.org/reference/scale_.html
Proposed fix
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 scale reference page at https://processing.org/reference/scale_.html and locate its source in the processing-website repository. Correct the example's percentage explanation and change the descriptions of s, x, and y from percentages to scalar or factor terminology; the page text should consistently describe scaling growth.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100