chore(code): Add description to all crates

informalsystems · Dec 18, 2024 · 55fc086 · 55fc086
1 parent 301261f
commit 55fc086
Show file tree

Hide file tree

Showing 18 changed files with 18 additions and 10 deletions.
diff --git a/code/crates/app-channel/Cargo.toml b/code/crates/app-channel/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-app-channel"
+description = "High-level interface for building channel-based applications on top of the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/app/Cargo.toml b/code/crates/app/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-app"
+description = "High-level interface for building applications on top of the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/codec/Cargo.toml b/code/crates/codec/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-codec"
+description = "Codec abstraction for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/config/Cargo.toml b/code/crates/config/Cargo.toml
@@ -1,7 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-config"
-description = "Node for running the Malachite consensus engine"
-
+description = "Configuration for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/core-consensus/Cargo.toml b/code/crates/core-consensus/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-core-consensus"
+description = "Core consensus algorithm for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/core-driver/Cargo.toml b/code/crates/core-driver/Cargo.toml
@@ -1,7 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-core-driver"
-description = "Driver for the state machine of Malachite consensus engine"
-
+description = "Driver for the state machine of Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/core-state-machine/Cargo.toml b/code/crates/core-state-machine/Cargo.toml
@@ -1,7 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-core-state-machine"
-description = "Core state-machine for the Malachite consensus engine"
-
+description = "Core state-machine for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/core-types/Cargo.toml b/code/crates/core-types/Cargo.toml
@@ -1,7 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-core-types"
-description = "Common datatypes and interfaces for the Malachite consensus engine"
-
+description = "Core type definitions and interfaces for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/core-votekeeper/Cargo.toml b/code/crates/core-votekeeper/Cargo.toml
@@ -1,7 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-core-votekeeper"
-description = "Voting system for the Malachite consensus engine"
-
+description = "Voting system for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/discovery/Cargo.toml b/code/crates/discovery/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-discovery"
+description = "Discovery protocol for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/engine/Cargo.toml b/code/crates/engine/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-engine"
+description = "Implementation of the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/metrics/Cargo.toml b/code/crates/metrics/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-metrics"
+description = "Metrics for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/network/Cargo.toml b/code/crates/network/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-network"
+description = "Networking layer for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/peer/Cargo.toml b/code/crates/peer/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-peer"
+description = "Peer definition for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/proto/Cargo.toml b/code/crates/proto/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-proto"
+description = "Protobuf abstraction for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/signing-ed25519/Cargo.toml b/code/crates/signing-ed25519/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-signing-ed25519"
+description = "Ed25519 signing scheme for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/sync/Cargo.toml b/code/crates/sync/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-sync"
+description = "Synchronization protocol for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true

diff --git a/code/crates/wal/Cargo.toml b/code/crates/wal/Cargo.toml
@@ -1,5 +1,6 @@
 [package]
 name = "informalsystems-malachitebft-wal"
+description = "Write-Ahead Log for for the Malachite BFT consensus engine"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true