processing / processing/processing-website
Documentation for image() is incomplete
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 90
- Forks
- 122
- Avg merge
- 1h 43m
- Merged PRs (30d)
- 3
Description
Issue description
The reference page for image() does not document the functionality for drawing a clipped section of the source image.
I ended up having to figure out the parameters for this (9-argument) version of image() through trial and error.
URL(s) of affected page(s)
https://processing.org/reference/image_.html
Proposed fix
Add example and documentation for this version.
The actual parameters seem to be:
image(image, targetX, targetY, targetWidth, targetHeight, sourceLeft, sourceTop, sourceRight, sourceBottom);
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 image() reference page at https://processing.org/reference/image_.html and review how its existing signatures and examples are documented. Add documentation and an example for the nine-argument clipped-source form; it is done when the parameters and behavior are clear on that page.
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