JuliaImages / JuliaImages/ImageDraw.jl
Documentation on "Drawing a Rectangle" is misleading
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 27
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
The example gives the impression that draw! returns a copy like draw
img = testimage("lighthouse")
img_example_stage1 = draw!(img, Polygon(RectanglePoints(Point(10, 10), Point(100, 100))), RGB{N0f8}(1))
img_example_stage2 = draw!(img_example_stage1, Polygon(RectanglePoints(CartesianIndex(110, 10), CartesianIndex(200, 200))), RGB{N0f8}(1))
img_example_stage3 = draw!(img_example_stage2, Polygon(RectanglePoints(220, 10, 300, 300)), RGB{N0f8}(1))
save("images/lighthouse_rectangle.png", img); nothing # hide
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
Start with the “Drawing a Rectangle” documentation example shown in the issue and review how the draw! calls are described or presented. Clarify the example so it does not imply that draw! returns a copy like draw; done means the documented behavior is no longer misleading.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100