Skip to content

Commit

Permalink
doc: add policy on project scope
Browse files Browse the repository at this point in the history
  • Loading branch information
dhardy committed Jul 12, 2018
1 parent e5134e8 commit 3682633
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,26 @@ TODO

### Project Scope

TODO
The `rand_core` library has the following scope:

- the core traits which RNGs may implement
- tools for implementing these traits

The `rand` library has the following scope:

- re-export all parts of `rand_core` applicable to end users
- an interface to request entropy from an external source
- hooks to provide entropy from several platform-specific sources
- traits covering common RNG functionality
- some PRNGs, notably `StdRng` and `SmallRng`
- `thread_rng` auto-seeding source of randomness
- conversion of random bits to common types and uses
- shuffling and sampling from sequences
- sampling from various random number distributions

Note: the scope of the project and above libraries may change. We are currently
discussing moving PRNGs (#431) and distributions (#290) to other libraries or
projects.

### Code style

Expand Down

0 comments on commit 3682633

Please sign in to comment.