Skip to content

Commit

Permalink
Extend Network doc comment for other networks (#382)
Browse files Browse the repository at this point in the history
* extend doc comment

* Fix spelling
  • Loading branch information
Thoralf-M authored Sep 3, 2021
1 parent 2cbb264 commit 821c12c
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion identity-iota/src/tangle/network.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ impl Network {
///
/// The names `"test"` and `"main"` will be mapped to the well-known [`Testnet`][Network::Testnet]
/// and [`Mainnet`][Network::Mainnet] networks respectively. Other inputs will return an instance
/// of [`Other`][Network::Other] if the name is valid.
/// of [`Other`][Network::Other] if the name is valid. It must match a part or all of the `networkId` returned in the
/// nodeinfo from a node. For example, if the networkId is `"private-tangle"`, `"tangle"` can be used.
///
/// Network names must comply with the IOTA DID Method spec, that is: be non-empty, at most
/// 6 characters long, and only include alphanumeric characters `0-9` and `a-z`.
Expand Down

0 comments on commit 821c12c

Please sign in to comment.