Add descriptions for cumulus/client crates

paritytech · Nov 7, 2023 · b44de38 · b44de38
1 parent f66d5ec
commit b44de38
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 0 deletions.
diff --git a/cumulus/client/cli/Cargo.toml b/cumulus/client/cli/Cargo.toml
@@ -3,6 +3,7 @@ name = "cumulus-client-cli"
 version = "0.1.0"
 authors.workspace = true
 edition.workspace = true
+description = "Parachain node CLI utilities."
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 
 [dependencies]

diff --git a/cumulus/client/collator/Cargo.toml b/cumulus/client/collator/Cargo.toml
@@ -3,6 +3,7 @@ name = "cumulus-client-collator"
 version = "0.1.0"
 authors.workspace = true
 edition.workspace = true
+description = "Common node-side functionality and glue code to collate parachain blocks."
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 
 [dependencies]

diff --git a/cumulus/client/relay-chain-inprocess-interface/Cargo.toml b/cumulus/client/relay-chain-inprocess-interface/Cargo.toml
@@ -3,6 +3,7 @@ authors.workspace = true
 name = "cumulus-relay-chain-inprocess-interface"
 version = "0.1.0"
 edition.workspace = true
+description = "Implementation of the RelayChainInterface trait for a polkadot full-node."
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 
 [dependencies]

diff --git a/cumulus/client/relay-chain-interface/Cargo.toml b/cumulus/client/relay-chain-interface/Cargo.toml
@@ -3,6 +3,7 @@ authors.workspace = true
 name = "cumulus-relay-chain-interface"
 version = "0.1.0"
 edition.workspace = true
+description = "Common interface for different relay chain datasources."
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 
 [dependencies]

diff --git a/cumulus/client/relay-chain-minimal-node/Cargo.toml b/cumulus/client/relay-chain-minimal-node/Cargo.toml
@@ -3,6 +3,7 @@ authors.workspace = true
 name = "cumulus-relay-chain-minimal-node"
 version = "0.1.0"
 edition.workspace = true
+description = "Minimal node implementation to be used in tandem with RPC or light-client mode."
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 
 [dependencies]

diff --git a/cumulus/client/relay-chain-rpc-interface/Cargo.toml b/cumulus/client/relay-chain-rpc-interface/Cargo.toml
@@ -3,6 +3,7 @@ authors.workspace = true
 name = "cumulus-relay-chain-rpc-interface"
 version = "0.1.0"
 edition.workspace = true
+description = "Implementation of the RelayChainInterface trait that connects to a remote RPC-node."
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 
 

diff --git a/cumulus/client/service/Cargo.toml b/cumulus/client/service/Cargo.toml
@@ -3,6 +3,7 @@ name = "cumulus-client-service"
 version = "0.1.0"
 authors.workspace = true
 edition.workspace = true
+description = "Common functions used to assemble the components of a parachain node."
 license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
 
 [dependencies]

diff --git a/cumulus/primitives/parachain-inherent/Cargo.toml b/cumulus/primitives/parachain-inherent/Cargo.toml
@@ -3,6 +3,7 @@ name = "cumulus-primitives-parachain-inherent"
 version = "0.1.0"
 authors.workspace = true
 edition.workspace = true
+description = "Inherent that needs to be present in every parachain block. Contains messages and a relay chain storage-proof."
 license = "Apache-2.0"
 
 [dependencies]