Rustdoc examples #69
Merged
Rustdoc examples #69
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add some short exerpts from the `mem_node` example to "Step 3: Process the Ready State".
|
Good job. |
QueenyJin
approved these changes
May 31, 2018
|
LGTM |
BusyJay
reviewed
Jun 4, 2018
| @@ -25,6 +25,181 @@ | |||
| // See the License for the specific language governing permissions and | |||
| // limitations under the License. | |||
|
|
|||
| /*! | |||
There was a problem hiding this comment.
Should we add a #[deny(missing_docs)]?
There was a problem hiding this comment.
I'd love to do that eventually but right now that would make the build fail until we added quite some documentation. I opened #72 to track this.
hicqu
reviewed
Jun 4, 2018
| network.send(vec![ | ||
| new_message(campaigner_id, campaigner_id, MessageType::MsgHup, 0), | ||
| ]); | ||
| network.send(vec
There was a problem hiding this comment.
Why the format is changed? With rustfmt required in TiKV:
$ rustfmt -V
rustfmt 0.4.1-nightly (a4462d1 2018-03-26)It format code in old style. I think we can follow that.
There was a problem hiding this comment.
Raft uses stable rustfmt, not nightly.
|
rest LGTM. |
|
LGTM. |
hicqu
approved these changes
Jun 5, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Supersedes #65.
Motivation
We're having lots of people who want to use Raft, but they don't know how! @queenypingcap did a great job assembling some examples and writing around how to use the crate, however it made the README very long.
This PR moves that content (with minor refactoring) into the Rust API docs generated by https://docs.rs/raft/ and
cargo doc.Further Work
There should be a follow up in the future that makes all examples fully tested, but for now this is a big enough step forward. :)