`RealField::min_value()` documentation does not match implementation

Open Beginner friendly
#86 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
64/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
rust
Domain
tooling

Research direction

Search the repository for RealField::min_value and the implementation shown in the issue. Read the surrounding trait or macro definitions to determine whether the documentation or the returned value is authoritative, then update the mismatched part and verify the relevant checks pass.

Written by the indexing model from the issue text.

Description

Hi,

min_value() is implemented as

/// The smallest finite positive value representable using this type.
#[inline]
fn min_value() -> Option<Self> {
    Some(<$T>::MIN)
}

But MIN is negative. MIN_POSITIVE might be the intended implementation if documentation is correct.

Dominant language
Rust
Stars
348
Forks
38
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from dimforge/simba

All issues in dimforge/simba

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.