Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
- fix document generate script in README
- tab format in Cargo.toml at root
- fix cli doc string with correct crate name
  • Loading branch information
yanganto committed Jan 9, 2020
1 parent 9a08671 commit 8140adb
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ panic = 'unwind'

[workspace]
members = [
"core/cli",
"core/ethash",
"core/cli",
"core/ethash",
# "core/merkle-mountain-range",
# "core/fly-client",
"core/sr-eth-primitives",
"core/merkle-patricia-trie",

"node/cli",
"node/cli",
"node/executor",
"node/primitives",
"node/rpc",
Expand Down
13 changes: 8 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -316,18 +316,21 @@ curl -H 'Content-Type: application/json' --data '{ "jsonrpc":"2.0", "method":"au
You can generate documentation for a Darwinia Rust package and have it automatically open in your web browser using https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html#using-rustdoc-with-cargo[rustdoc with Cargo],
(of the The Rustdoc Book), by running the following command:

```
cargo doc --open
```

If you just want to generate document from specific package, you may use following command:

```
cargo doc --package <spec> --open
```

Replacing `<spec>` with one of the following (i.e. `cargo doc --package darwinia --open`):
Replacing `<spec>` with one of the following (i.e. `cargo doc --package darwinia-cli --open`):

* All Darwinia Packages
[source, shell]
darwinia
* Darwinia Core
[source, shell]
darwinia, darwinia-cli, ethash, fly-client,
darwinia-cli, ethash, fly-client,
merkle-mountain-range, merkle-patricia-trie, sr-eth-primitives
* Darwinia Runtime Module Library
[source, shell]
Expand Down
2 changes: 1 addition & 1 deletion node/cli/bin/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
// You should have received a copy of the GNU General Public License
// along with Substrate. If not, see <http://www.gnu.org/licenses/>.

//! Substrate Node CLI
//! Darwinia

#![warn(missing_docs)]

Expand Down
2 changes: 1 addition & 1 deletion node/cli/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
// You should have received a copy of the GNU General Public License
// along with Substrate. If not, see <http://www.gnu.org/licenses/>.

//! Substrate CLI library.
//! Darwminia CLI library.

#![warn(missing_docs)]
#![warn(unused_extern_crates)]
Expand Down

0 comments on commit 8140adb

Please sign in to comment.