Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign upAdd Crate level documentation and Cargo attributes #438
Conversation
This comment has been minimized.
This comment has been minimized.
|
@AndyGauge I see some travis failures; I suspect they are unrelated to this PR, but would you mind rebasing? |
AndyGauge
force-pushed the
AndyGauge:docs
branch
from
b225650
to
1843312
Sep 22, 2017
This comment has been minimized.
This comment has been minimized.
|
There's doc code that needs to be modified. I'll figure it out. |
AndyGauge
force-pushed the
AndyGauge:docs
branch
from
1843312
to
64e464d
Sep 22, 2017
AndyGauge
force-pushed the
AndyGauge:docs
branch
from
64e464d
to
0fcce4a
Sep 22, 2017
This comment has been minimized.
This comment has been minimized.
|
OK, this is ready for review. Thanks |
| //! | ||
| //! # Parallel Iterators | ||
| //! | ||
| //! Parallel iterators are formed using [`par_iter`] and `par_iter_mut` functions |
This comment has been minimized.
This comment has been minimized.
cuviper
Sep 23, 2017
Member
It's strange to me that you've linked par_iter to the ParallelIterator trait. It is good to have that link up front, but par_iter itself comes from IntoParallelRefIterator. There are actually three such conversions, into_par_iter(), par_iter(), and par_iter_mut(), to iterate respectively by value, by shared reference, or by mutable reference.
| //! _ => *c | ||
| //! } | ||
| //! }).collect(); | ||
| //! # } |
This comment has been minimized.
This comment has been minimized.
cuviper
Sep 23, 2017
Member
It would be good to assert_eq! the result so readers know what to expect, and so it also serves as a doctest.
| //! ``` | ||
| //! | ||
| //! Here a string is encrypted using ROT13 leveraging parallelism. Once all the | ||
| //! threads are complete, they are collected into a string. |
This comment has been minimized.
This comment has been minimized.
cuviper
Sep 23, 2017
Member
I think it reads better to place such descriptions before the example code.
| @@ -8,6 +8,9 @@ description = "Simple work-stealing parallelism for Rust" | |||
| license = "Apache-2.0/MIT" | |||
| repository = "https://github.com/nikomatsakis/rayon" | |||
| documentation = "https://docs.rs/rayon/" | |||
| readme = "README.md" | |||
| keywords = ["parallel", "thread", "concurrency", "join", "performance"] | |||
| categories = ["concurrency"] | |||
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
AndyGauge
Sep 25, 2017
Author
Contributor
I'm not sure if readme attribute is appropriate. I added '..\readme.md'. Not sure if that is helpful or if the other 'crates' need their own readmes.
This comment has been minimized.
This comment has been minimized.
cuviper
Sep 26, 2017
Member
I have no idea if crates.io will work with ../README.md -- I doubt it though, because it's probably looking at the individual uploaded crates, not the repository.
We do have a readme in rayon-futures, but not rayon-core. The latter could just be a simple placeholder, saying something like "Core APIs for Rayon; see the rayon crate for more details."
AndyGauge
added some commits
Sep 25, 2017
cuviper
approved these changes
Sep 26, 2017
This comment has been minimized.
This comment has been minimized.
|
Thanks! |
AndyGauge commentedSep 12, 2017
Fixes #418
Fixes #423