Add descriptions to all published crates (#2029)

Missing descriptions (47): - [x] `cumulus/client/collator/Cargo.toml` - [x] `cumulus/client/relay-chain-inprocess-interface/Cargo.toml` - [x] `cumulus/client/cli/Cargo.toml` - [x] `cumulus/client/service/Cargo.toml` - [x] `cumulus/client/relay-chain-rpc-interface/Cargo.toml` - [x] `cumulus/client/relay-chain-interface/Cargo.toml` - [x] `cumulus/client/relay-chain-minimal-node/Cargo.toml` - [x] `cumulus/parachains/pallets/parachain-info/Cargo.toml` - [x] `cumulus/parachains/pallets/ping/Cargo.toml` - [x] `cumulus/primitives/utility/Cargo.toml` - [x] `cumulus/primitives/aura/Cargo.toml` - [x] `cumulus/primitives/core/Cargo.toml` - [x] `cumulus/primitives/parachain-inherent/Cargo.toml` - [x] `cumulus/test/relay-sproof-builder/Cargo.toml` - [x] `cumulus/pallets/xcmp-queue/Cargo.toml` - [x] `cumulus/pallets/dmp-queue/Cargo.toml` - [x] `cumulus/pallets/xcm/Cargo.toml` - [x] `polkadot/erasure-coding/Cargo.toml` - [x] `polkadot/statement-table/Cargo.toml` - [x] `polkadot/primitives/Cargo.toml` - [x] `polkadot/rpc/Cargo.toml` - [x] `polkadot/node/service/Cargo.toml` - [x] `polkadot/node/core/parachains-inherent/Cargo.toml` - [x] `polkadot/node/core/approval-voting/Cargo.toml` - [x] `polkadot/node/core/dispute-coordinator/Cargo.toml` - [x] `polkadot/node/core/av-store/Cargo.toml` - [x] `polkadot/node/core/chain-api/Cargo.toml` - [x] `polkadot/node/core/prospective-parachains/Cargo.toml` - [x] `polkadot/node/core/backing/Cargo.toml` - [x] `polkadot/node/core/provisioner/Cargo.toml` - [x] `polkadot/node/core/runtime-api/Cargo.toml` - [x] `polkadot/node/core/bitfield-signing/Cargo.toml` - [x] `polkadot/node/network/dispute-distribution/Cargo.toml` - [x] `polkadot/node/network/bridge/Cargo.toml` - [x] `polkadot/node/network/collator-protocol/Cargo.toml` - [x] `polkadot/node/network/approval-distribution/Cargo.toml` - [x] `polkadot/node/network/availability-distribution/Cargo.toml` - [x] `polkadot/node/network/bitfield-distribution/Cargo.toml` - [x] `polkadot/node/network/gossip-support/Cargo.toml` - [x] `polkadot/node/network/availability-recovery/Cargo.toml` - [x] `polkadot/node/collation-generation/Cargo.toml` - [x] `polkadot/node/overseer/Cargo.toml` - [x] `polkadot/runtime/parachains/Cargo.toml` - [x] `polkadot/runtime/common/slot_range_helper/Cargo.toml` - [x] `polkadot/runtime/metrics/Cargo.toml` - [x] `polkadot/xcm/pallet-xcm-benchmarks/Cargo.toml` - [x] `polkadot/utils/generate-bags/Cargo.toml` - [x] `substrate/bin/minimal/runtime/Cargo.toml` --------- Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Signed-off-by: alindima <alin@parity.io> Co-authored-by: ordian <noreply@reusable.software> Co-authored-by: Tsvetomir Dimitrov <tsvetomir@parity.io> Co-authored-by: Marcin S <marcin@realemail.net> Co-authored-by: alindima <alin@parity.io> Co-authored-by: Sebastian Kunert <skunert49@gmail.com> Co-authored-by: Dmitry Markin <dmitry@markin.tech> Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com> Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
paritytech · Nov 9, 2023 · 48ea86f · 48ea86f
1 parent d347d68
commit 48ea86f
Show file tree

Hide file tree

Showing 47 changed files with 51 additions and 1 deletion.
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 Polkadot full-nodes."
 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/pallets/xcm/Cargo.toml b/cumulus/pallets/xcm/Cargo.toml
@@ -4,6 +4,7 @@ edition.workspace = true
 name = "cumulus-pallet-xcm"
 version = "0.1.0"
 license = "Apache-2.0"
+description = "Pallet for stuff specific to parachains' usage of XCM"
 
 [dependencies]
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }

diff --git a/cumulus/pallets/xcmp-queue/Cargo.toml b/cumulus/pallets/xcmp-queue/Cargo.toml
@@ -3,6 +3,7 @@ name = "cumulus-pallet-xcmp-queue"
 version = "0.1.0"
 authors.workspace = true
 edition.workspace = true
+description = "Pallet to queue outbound and inbound XCMP messages."
 license = "Apache-2.0"
 
 [dependencies]

diff --git a/cumulus/parachains/pallets/parachain-info/Cargo.toml b/cumulus/parachains/pallets/parachain-info/Cargo.toml
@@ -4,6 +4,7 @@ edition.workspace = true
 name = "staging-parachain-info"
 version = "0.1.0"
 license = "Apache-2.0"
+description = "Pallet to store the parachain ID"
 
 [dependencies]
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }

diff --git a/cumulus/parachains/pallets/ping/Cargo.toml b/cumulus/parachains/pallets/ping/Cargo.toml
@@ -4,6 +4,7 @@ edition.workspace = true
 name = "cumulus-ping"
 version = "0.1.0"
 license = "Apache-2.0"
+description = "Ping Pallet for Cumulus XCM/UMP testing."
 
 [dependencies]
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }

diff --git a/cumulus/primitives/aura/Cargo.toml b/cumulus/primitives/aura/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors.workspace = true
 edition.workspace = true
 license = "Apache-2.0"
+description = "Core primitives for Aura in Cumulus"
 
 [dependencies]
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = [ "derive" ] }

diff --git a/cumulus/primitives/core/Cargo.toml b/cumulus/primitives/core/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors.workspace = true
 edition.workspace = true
 license = "Apache-2.0"
+description = "Cumulus related core primitive types and traits"
 
 [dependencies]
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = [ "derive" ] }

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]

diff --git a/cumulus/primitives/utility/Cargo.toml b/cumulus/primitives/utility/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors.workspace = true
 edition.workspace = true
 license = "Apache-2.0"
+description = "Helper datatypes for Cumulus"
 
 [dependencies]
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = [ "derive" ] }

diff --git a/cumulus/test/relay-sproof-builder/Cargo.toml b/cumulus/test/relay-sproof-builder/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 authors.workspace = true
 edition.workspace = true
 license = "Apache-2.0"
+description = "Mocked relay state proof builder for testing Cumulus."
 
 [dependencies]
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = [ "derive" ] }

diff --git a/polkadot/erasure-coding/Cargo.toml b/polkadot/erasure-coding/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "polkadot-erasure-coding"
 version = "1.0.0"
+description = "Erasure coding used for Polkadot's availability system"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

diff --git a/polkadot/node/collation-generation/Cargo.toml b/polkadot/node/collation-generation/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "Collator-side subsystem that handles incoming candidate submissions from the parachain."
 
 [dependencies]
 futures = "0.3.21"

diff --git a/polkadot/node/core/approval-voting/Cargo.toml b/polkadot/node/core/approval-voting/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "Approval Voting Subsystem of the Polkadot node"
 
 [dependencies]
 futures = "0.3.21"

diff --git a/polkadot/node/core/av-store/Cargo.toml b/polkadot/node/core/av-store/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "polkadot-node-core-av-store"
+description = "The Availability Store subsystem. Wrapper over the DB that stores availability data and chunks."
 version = "1.0.0"
 authors.workspace = true
 edition.workspace = true

diff --git a/polkadot/node/core/backing/Cargo.toml b/polkadot/node/core/backing/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "The Candidate Backing Subsystem. Tracks parachain candidates that can be backed, as well as the issuance of statements about candidates."
 
 [dependencies]
 futures = "0.3.21"

diff --git a/polkadot/node/core/bitfield-signing/Cargo.toml b/polkadot/node/core/bitfield-signing/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "Bitfield signing subsystem for the Polkadot node"
 
 [dependencies]
 futures = "0.3.21"

diff --git a/polkadot/node/core/chain-api/Cargo.toml b/polkadot/node/core/chain-api/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "The Chain API subsystem provides access to chain related utility functions like block number to hash conversions."
 
 [dependencies]
 futures = "0.3.21"

diff --git a/polkadot/node/core/dispute-coordinator/Cargo.toml b/polkadot/node/core/dispute-coordinator/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "polkadot-node-core-dispute-coordinator"
 version = "1.0.0"
+description = "The node-side components that participate in disputes"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

diff --git a/polkadot/node/core/parachains-inherent/Cargo.toml b/polkadot/node/core/parachains-inherent/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "Parachains inherent data provider for Polkadot node"
 
 [dependencies]
 futures = "0.3.21"

diff --git a/polkadot/node/core/prospective-parachains/Cargo.toml b/polkadot/node/core/prospective-parachains/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "The Prospective Parachains subsystem. Tracks and handles prospective parachain fragments."
 
 [dependencies]
 futures = "0.3.19"

diff --git a/polkadot/node/core/provisioner/Cargo.toml b/polkadot/node/core/provisioner/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "polkadot-node-core-provisioner"
 version = "1.0.0"
+description="Responsible for assembling a relay chain block from a set of available parachain candidates"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

diff --git a/polkadot/node/core/runtime-api/Cargo.toml b/polkadot/node/core/runtime-api/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "polkadot-node-core-runtime-api"
 version = "1.0.0"
+description="Wrapper around the parachain-related runtime APIs"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

diff --git a/polkadot/node/network/approval-distribution/Cargo.toml b/polkadot/node/network/approval-distribution/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "polkadot-approval-distribution"
 version = "1.0.0"
+description = "Polkadot Approval Distribution subsystem for the distribution of assignments and approvals for approval checks on candidates over the network."
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

diff --git a/polkadot/node/network/availability-distribution/Cargo.toml b/polkadot/node/network/availability-distribution/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "polkadot-availability-distribution"
+description = "The Availability Distribution subsystem. Requests the required availability data. Also distributes availability data and chunks to requesters."
 version = "1.0.0"
 authors.workspace = true
 edition.workspace = true

diff --git a/polkadot/node/network/availability-recovery/Cargo.toml b/polkadot/node/network/availability-recovery/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "polkadot-availability-recovery"
+description = "The Availability Recovery subsystem. Handles requests for recovering the availability data of included candidates."
 version = "1.0.0"
 authors.workspace = true
 edition.workspace = true

diff --git a/polkadot/node/network/bitfield-distribution/Cargo.toml b/polkadot/node/network/bitfield-distribution/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "polkadot-availability-bitfield-distribution"
 version = "1.0.0"
+description = "Polkadot Bitfiled Distribution subsystem, which gossips signed availability bitfields used to compactly determine which backed candidates are available or not based on a 2/3+ quorum."
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

diff --git a/polkadot/node/network/bridge/Cargo.toml b/polkadot/node/network/bridge/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "polkadot-network-bridge"
 version = "1.0.0"
+description = "The Network Bridge Subsystem — protocol multiplexer for Polkadot."
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

diff --git a/polkadot/node/network/collator-protocol/Cargo.toml b/polkadot/node/network/collator-protocol/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "polkadot-collator-protocol"
 version = "1.0.0"
+description = "Polkadot Collator Protocol subsystem. Allows collators and validators to talk to each other."
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

diff --git a/polkadot/node/network/dispute-distribution/Cargo.toml b/polkadot/node/network/dispute-distribution/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "polkadot-dispute-distribution"
 version = "1.0.0"
+description = "Polkadot Dispute Distribution subsystem, which ensures all concerned validators are aware of a dispute and have the relevant votes."
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

diff --git a/polkadot/node/network/gossip-support/Cargo.toml b/polkadot/node/network/gossip-support/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "polkadot-gossip-support"
 version = "1.0.0"
+description = "Polkadot Gossip Support subsystem. Responsible for keeping track of session changes and issuing a connection request to the relevant validators on every new session."
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

diff --git a/polkadot/node/overseer/Cargo.toml b/polkadot/node/overseer/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "System overseer of the Polkadot node"
 
 [dependencies]
 client = { package = "sc-client-api", path = "../../../substrate/client/api" }

diff --git a/polkadot/node/service/Cargo.toml b/polkadot/node/service/Cargo.toml
@@ -5,6 +5,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "Utils to tie different Polkadot components together and allow instantiation of a node."
 
 [dependencies]
 # Substrate Client

diff --git a/polkadot/primitives/Cargo.toml b/polkadot/primitives/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "Shared primitives used by Polkadot runtime"
 
 [dependencies]
 bitvec = { version = "1.0.0", default-features = false, features = ["alloc"] }

diff --git a/polkadot/rpc/Cargo.toml b/polkadot/rpc/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "Polkadot specific RPC functionality."
 
 [dependencies]
 jsonrpsee = { version = "0.16.2", features = ["server"] }

diff --git a/polkadot/runtime/common/slot_range_helper/Cargo.toml b/polkadot/runtime/common/slot_range_helper/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "Helper crate for generating slot ranges for the Polkadot runtime."
 
 [dependencies]
 paste = "1.0"

diff --git a/polkadot/runtime/metrics/Cargo.toml b/polkadot/runtime/metrics/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "Runtime metric interface for the Polkadot node"
 
 [dependencies]
 sp-std = { package = "sp-std", path = "../../../substrate/primitives/std", default-features = false}

diff --git a/polkadot/runtime/parachains/Cargo.toml b/polkadot/runtime/parachains/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "polkadot-runtime-parachains"
 version = "1.0.0"
+description = "Relay Chain runtime code responsible for Parachains."
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

diff --git a/polkadot/statement-table/Cargo.toml b/polkadot/statement-table/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "Stores messages other authorities issue about candidates in Polkadot."
 
 [dependencies]
 parity-scale-codec = { version = "3.6.1", default-features = false, features = ["derive"] }

diff --git a/polkadot/utils/generate-bags/Cargo.toml b/polkadot/utils/generate-bags/Cargo.toml
@@ -4,6 +4,7 @@ version = "1.0.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
+description = "CLI to generate voter bags for Polkadot runtimes"
 
 [dependencies]
 clap = { version = "4.4.6", features = ["derive"] }

diff --git a/polkadot/xcm/pallet-xcm-benchmarks/Cargo.toml b/polkadot/xcm/pallet-xcm-benchmarks/Cargo.toml
@@ -4,6 +4,7 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 version = "1.0.0"
+description = "Benchmarks for the XCM pallet"
 
 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]

diff --git a/substrate/bin/minimal/runtime/Cargo.toml b/substrate/bin/minimal/runtime/Cargo.toml
@@ -1,7 +1,11 @@
 [package]
 name = "minimal-runtime"
 version = "0.1.0"
-edition = "2021"
+authors.workspace = true
+description = "A minimal Substrate example runtime"
+edition.workspace = true
+repository.workspace = true
+license.workspace = true
 
 [dependencies]
 parity-scale-codec = { version = "3.0.0", default-features = false }