adding verbose rustdoc to diff between build-spec and chain-spec-builder #7698
+23
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seemantaggarwal
added
R0-silent
iulianbarbu
reviewed
Feb 25, 2025
There was a problem hiding this comment.
Suggested some changes. If we're polishing the docs, I would change as part of this PR the polkadot-omni-node README and suggest there instead of installing chain-spec-builder standalone, to use the chain-spec-builder subcommand.
I would also change the parachain/minimal templates READMEs to rely on polkadot-omni-node chain-spec-builder instead of the standalone chain-spec-builder binary.
Co-authored-by: Iulian Barbu <14218860+iulianbarbu@users.noreply.github.com>
Co-authored-by: Iulian Barbu <14218860+iulianbarbu@users.noreply.github.com>
skunert
reviewed
Mar 3, 2025
| /// pages: | ||
| /// - https://crates.io/crates/staging-chain-spec-builder | ||
| /// - https://docs.rs/staging-chain-spec-builder/latest/staging_chain_spec_builder/ | ||
| /// --- |
skunert
approved these changes
Mar 3, 2025
| /// configurations, `chain-spec-builder` provides a more interactive and customizable approach | ||
| /// to defining a chain spec. It allows users to create specifications with additional | ||
| /// parameters and validation steps before finalizing the output. | ||
| /// `chain-spec-builder` subcommand corresponds to the existing `chain-spec-builder` tool |
There was a problem hiding this comment.
Suggested change
| /// `chain-spec-builder` subcommand corresponds to the existing `chain-spec-builder` tool | |
| /// | |
| /// A `chain-spec-builder` subcommand corresponds to the existing `chain-spec-builder` tool |
| @@ -72,6 +72,16 @@ pub enum Subcommand { | |||
| Key(sc_cli::KeySubcommand), | |||
|
|
|||
| /// Build a chain specification. | |||
| /// The `build-spec` command relies on the chain specification built (hard-coded) into the node | |||
There was a problem hiding this comment.
Suggested change
| /// The `build-spec` command relies on the chain specification built (hard-coded) into the node | |
| /// | |
| /// The `build-spec` command relies on the chain specification built (hard-coded) into the node |
There was a problem hiding this comment.
Addressed in 0d97dbe
michalkucharczyk
approved these changes
Mar 4, 2025
|
/cmd fmt |
|
All GitHub workflows were cancelled due to failure one of the required jobs. |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
iulianbarbu
approved these changes
Mar 5, 2025
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow up from #7619
Adding a more verbose rustdoc for guidance and difference between chain-spec-builder and build-spec commands under polkadot-omni-node