Skip to content

Commit

Permalink
doc: add links
Browse files Browse the repository at this point in the history
  • Loading branch information
dhardy committed Jul 10, 2018
1 parent ac42bee commit 9534ba4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 2 additions & 3 deletions README.md
Expand Up @@ -16,9 +16,8 @@ The core random number generation traits of Rand live in the [rand_core](
https://crates.io/crates/rand_core) crate; this crate is most useful when
implementing RNGs.

API reference:
[master branch](https://rust-lang-nursery.github.io/rand/rand/index.html),
[by release](https://docs.rs/rand/0.5).
[Additional documentation is here](doc/README.md).
[API reference is here](https://docs.rs/rand).

## Usage

Expand Down
4 changes: 3 additions & 1 deletion doc/README.md
@@ -1,5 +1,7 @@
# Rand Documentation

Also see the [main project readme](../README.md).

## Learning Rand

TODO. In the mean-time, we have some learning resources within the API
Expand Down Expand Up @@ -113,7 +115,7 @@ We do not currently have many policies on style other than:
Rand does **make use of `unsafe`**, both for performance and out of necessity.
We consider this acceptable so long as correctness is easy to verify.
In order to make this as simple as possible,
we prefer that all parameters affecting safety of `unsafe` blocks as checked or
we prefer that all parameters affecting safety of `unsafe` blocks are checked or
prepared close to the `unsafe` code,
and wherever possible within the same function (thus making the function safe).

Expand Down

0 comments on commit 9534ba4

Please sign in to comment.