Skip to content

Commit

Permalink
Merge #278
Browse files Browse the repository at this point in the history
278: small adjustments in the documentation r=torkleyy a=hartmut

minor changes in the specs book
  • Loading branch information
bors[bot] committed Oct 2, 2017
2 parents 4fddd31 + 3213160 commit b91e2df
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion book/src/02_hello_world.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ them. To execute the system, you can use `RunNow` like this:
```rust,ignore
use specs::RunNow;
let hello_world = HelloWorld;
let mut hello_world = HelloWorld;
hello_world.run_now(&world.res);
```

Expand Down
4 changes: 2 additions & 2 deletions book/src/04_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ So we can now rewrite our system:
```rust,ignore
use specs::{Fetch, ReadStorage, System, WriteStorage};
struct PosUpdate;
struct UpdatePos;
impl<'a> System<'a> for PosUpdate {
impl<'a> System<'a> for UpdatePos {
type SystemData = (Fetch<'a, DeltaTime>,
ReadStorage<'a, Velocity>,
WriteStorage<'a, Position>);
Expand Down
4 changes: 2 additions & 2 deletions book/src/05_storages.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ than a `usize` because it consumes less RAM.

## `HashMapStorage`

This should be used for components which are associated to very few entities,
This should be used for components which are associated to very few entities,
because it provides a lower insertion cost and is packed together more tightly.
You should not use it for frequently used components, because the hashing cost would definitely
You should not use it for frequently used components, because the hashing cost would definitely
be noticeable.

## `NullStorage`
Expand Down
4 changes: 3 additions & 1 deletion book/src/07_parallel_join.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ method call can be exchanged for `par_join`:
}
```

The `par_join` method produces a type implementing `rayon`s `ParallelIterator`
The `par_join` method produces a type implementing [`rayon`s `ParallelIterator`][ra]
trait which provides lots of helper methods to manipulate the iteration,
the same way as the normal `Iterator` trait does.

[ra]: https://crates.io/crates/rayon

0 comments on commit b91e2df

Please sign in to comment.