image-rs / image-rs/imageproc

draw_line_segment() signature inconsistency

Open
#150 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
979
Forks
181
Avg merge
5m
Merged PRs (30d)
4

Description

I noticed a small inconsistency between two related function signatures when I was using this library. Of course, changing the signature would break anyone using these functions, and I'm not sure what the policy would be regarding that.

imageproc::drawing::draw_antialiased_line_segment takes tuples of type i32, but imageproc::drawing::draw_line_segment takes tuples of type f32.

It would seem appropriate for both to fake f32 tuples.

As an aside, I'm new to Rust, and I'm interested in contributing to this library. I'd like to start by adding some more testing, as well as some more example code, since those are mentioned in the README.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the signatures of imageproc::drawing::draw_antialiased_line_segment and imageproc::drawing::draw_line_segment, then review the README's contribution guidance for testing and examples. Resolve the compatibility policy for changing the public API and add tests and example code that reflect the agreed consistent signatures.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
computer-vision
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.