Skip to content

Commit

Permalink
Correct some typos in crates' descriptions (#5262)
Browse files Browse the repository at this point in the history
Co-authored-by: Bastian Köcher <git@kchr.de>
  • Loading branch information
rzadp and bkchr authored Aug 15, 2024
1 parent 63bf73d commit a6dffe3
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 8 deletions.
2 changes: 1 addition & 1 deletion cumulus/client/pov-recovery/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = "cumulus-client-pov-recovery"
version = "0.7.0"
authors.workspace = true
description = "Cumulus-specific networking protocol"
description = "Parachain PoV recovery"
edition.workspace = true
license = "GPL-3.0-or-later WITH Classpath-exception-2.0"

Expand Down
2 changes: 1 addition & 1 deletion cumulus/pallets/aura-ext/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

//! Cumulus extension pallet for AuRa
//!
//! This pallets extends the Substrate AuRa pallet to make it compatible with parachains. It
//! This pallet extends the Substrate AuRa pallet to make it compatible with parachains. It
//! provides the [`Pallet`], the [`Config`] and the [`GenesisConfig`].
//!
//! It is also required that the parachain runtime uses the provided [`BlockExecutor`] to properly
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "bridge-hub-rococo-runtime"
version = "0.5.0"
authors.workspace = true
edition.workspace = true
description = "Rococo's BridgeHub parachain runtime"
description = "Rococo's BridgeHub parachain runtime"
license = "Apache-2.0"

[lints]
Expand Down
25 changes: 25 additions & 0 deletions prdoc/pr_5262.prdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json

title: Correct some typos in crates' descriptions

doc:
- audience: Runtime Dev
description: |
Corrected typos and copy-paste errors in crates' descriptions.

crates:
- name: cumulus-client-pov-recovery
bump: patch
- name: cumulus-pallet-aura-ext
bump: patch
- name: bridge-hub-rococo-runtime
bump: patch
- name: frame-try-runtime
bump: patch
- name: pallet-whitelist
bump: patch
- name: polkadot-sdk
bump: patch
- name: polkadot-runtime-parachains
bump: none
2 changes: 1 addition & 1 deletion substrate/frame/try-runtime/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ edition.workspace = true
license = "Apache-2.0"
homepage.workspace = true
repository.workspace = true
description = "FRAME pallet for democracy"
description = "Supporting types for try-runtime, testing and dry-running commands."

[lints]
workspace = true
Expand Down
2 changes: 1 addition & 1 deletion substrate/frame/whitelist/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ edition.workspace = true
license = "Apache-2.0"
homepage.workspace = true
repository.workspace = true
description = "FRAME pallet for whitelisting call, and dispatch from specific origin"
description = "FRAME pallet for whitelisting calls, and dispatching from a specific origin"

[lints]
workspace = true
Expand Down
6 changes: 3 additions & 3 deletions umbrella/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ pub use cumulus_client_network;
#[cfg(feature = "cumulus-client-parachain-inherent")]
pub use cumulus_client_parachain_inherent;

/// Cumulus-specific networking protocol.
/// Parachain PoV recovery.
#[cfg(feature = "cumulus-client-pov-recovery")]
pub use cumulus_client_pov_recovery;

Expand Down Expand Up @@ -272,7 +272,7 @@ pub use frame_system_benchmarking;
#[cfg(feature = "frame-system-rpc-runtime-api")]
pub use frame_system_rpc_runtime_api;

/// FRAME pallet for democracy.
/// Supporting types for try-runtime, testing and dry-running commands.
#[cfg(feature = "frame-try-runtime")]
pub use frame_try_runtime;

Expand Down Expand Up @@ -689,7 +689,7 @@ pub use pallet_utility;
#[cfg(feature = "pallet-vesting")]
pub use pallet_vesting;

/// FRAME pallet for whitelisting call, and dispatch from specific origin.
/// FRAME pallet for whitelisting calls, and dispatching from a specific origin.
#[cfg(feature = "pallet-whitelist")]
pub use pallet_whitelist;

Expand Down

0 comments on commit a6dffe3

Please sign in to comment.