Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation should state the purpose of the num-traits crate #259

Open
CaliViking opened this issue Feb 18, 2023 · 0 comments
Open

Documentation should state the purpose of the num-traits crate #259

CaliViking opened this issue Feb 18, 2023 · 0 comments

Comments

@CaliViking
Copy link

The thing I find most confusing about num-trait is that there is no definition of the purpose and scope of the trait. The documentation says nothing about how the developers were thinking or how the user should understand what was developed, instead it dives straight into the details.

Num traits seem to be such a fundamental and critical building block when writing generic structs and implementations. It also seems like there is value in adding num traits to other custom structs where the methods can be implemented. The problem is that I have no idea if this is correct. Is num-traits supposed to be used with generics, or is it not?

Could someone who understands the crate thoroughly add the following to the beginning of the documentation:

  1. The purpose of num-traits
  2. Scope of num-traits
  3. When not to use num-traits

I would love to write it, but I don't have the necessary information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant