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

README: what rand is / is not #1065

Merged
merged 3 commits into from Nov 19, 2020
Merged

README: what rand is / is not #1065

merged 3 commits into from Nov 19, 2020

Conversation

dhardy
Copy link
Member

@dhardy dhardy commented Nov 18, 2020

@vks @newpavlov in light of #989 and several other critiques of this crate, I think perhaps we should clarify what Rand is / is not (because we can't satisfy everyone). This should appear on the crates page when next published, so it should be succinct but not too brief. Thoughts?

Should we mention "Stable" since we're not at 1.0 yet? To me there's little point, but some people may care.

@newpavlov
Copy link
Member

newpavlov commented Nov 18, 2020

I think adding the helper functions can cover 80% of current uses of fastrand/oorandom. We will not be as small and minimal as them, but we can cover the "simple" part. We can start by copying the fastrand API, but I haven't come up with a good naming scheme.

Should we mention "Stable" since we're not at 1.0 yet?

I think we can mention that API is relatively stable, but future breaking releases are possible (e.g. after const generics stabilization). Also that we strictly follow the policy which considers MSRV bumps a breaking change.

@dhardy
Copy link
Member Author

dhardy commented Nov 18, 2020

To me, "simple" means "the code is easy to understand". Additional API doesn't change that. Maybe this isn't clear?

I'm still not convinced the helper functions would be useful. (Maybe the three of us should vote on it, in which case my vote is no so @vks gets the deciding vote.)

README.md Outdated
and [oorandom](https://crates.io/crates/oorandom).
- Slow. We take performance seriously, with considerations also for set-up
time of new distributions, commonly-used parameters, and parameters of the
current sampler
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a . missing at the end.

Copy link
Collaborator

@vks vks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@vks
Copy link
Collaborator

vks commented Nov 18, 2020

To me, "simple" means "the code is easy to understand". Additional API doesn't change that. Maybe this isn't clear?

There is "simple to understand" and "simple to use". Additional API may help with the latter. Maybe there is a better word than simple?

@dhardy
Copy link
Member Author

dhardy commented Nov 18, 2020

Maybe "simple code"?

@vks
Copy link
Collaborator

vks commented Nov 18, 2020

Alternatively "simple implementation" could work. "Minimal" might be an option too.

@dhardy
Copy link
Member Author

dhardy commented Nov 18, 2020

Updated. Versions section revised.

@dhardy dhardy merged commit 2177a3d into rust-random:master Nov 19, 2020
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

Successfully merging this pull request may close these issues.

None yet

3 participants