PistonDevelopers / PistonDevelopers/piston
Error in piston docs Rectangle.draw method
Open
Beginner friendly
Nobody has claimed this yet.
enhancement
- Dominant language
- Rust
- Stars
- 4.7k
- Forks
- 235
- Avg merge
- 1m
- Merged PRs (30d)
- 4
Description
The documentation says
draw_statedraw state,draw_state::Default::default()can be used as a default,
It should be draw_state::DrawState::default()
https://docs.piston.rs/piston_window/graphics/rectangle/struct.Rectangle.html#method.draw
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
Open the linked Rectangle.draw documentation and compare the displayed draw_state default with the issue report. Update the documented Rust path to the correct default expression, then verify the rendered method documentation shows the corrected text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100