rust: add rustdoc descriptions to the public API and tiny improvements for crates.io #589
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
axic
commented
Oct 6, 2020
| @@ -0,0 +1,5 @@ | |||
| # Fizzy | |||
There was a problem hiding this comment.
This is what will be visible on crates.io
Codecov Report
@@ Coverage Diff @@
## master #589 +/- ##
=========================================
Coverage ? 98.23%
=========================================
Files ? 62
Lines ? 9023
Branches ? 0
=========================================
Hits ? 8864
Misses ? 159
Partials ? 0 |
chfast
requested changes
Oct 7, 2020
|
I know, I would merge this first. |
|
Please combine these 2 PRs to avoid the noise. |
|
What noise? |
axic
changed the title
chfast
approved these changes
Oct 7, 2020
| @@ -2,10 +2,15 @@ | |||
| // Copyright 2019-2020 The Fizzy Authors. | |||
| // SPDX-License-Identifier: Apache-2.0 | |||
|
|
|||
| //! This is a Rust interface to [Fizzy](https://github.com/wasmx/fizzy), a WebAssembly virtual machine. | |||
There was a problem hiding this comment.
What's the difference between //! and ///?
There was a problem hiding this comment.
//! is the description shown on the top of docs.rust.rs, while /// is the doxygen compatible description for syntactical elements. So basically //! stuff becomes the "README" for the documentation.
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.
No description provided.