Fix deps for local docs build for Rust 1.75.0 (#2896)

- Fix docs deps build issue
(https://github.com/servo/rust-smallvec/issues/327) (Please forgive me
and LMK if there are processes I need to follow for the bump a dep here
I am not aware of).
- Fix links for `meta_contributing` docs, internal and external.
- `cargo +nightly fmt` for `/docs/...` files
This commit is contained in:
Nuke
2024-01-09 18:18:59 -07:00
committed by GitHub
parent ce4e5496de
commit 01ea45c3a1
4 changed files with 16 additions and 15 deletions
Generated
+2 -2
View File
@@ -17418,9 +17418,9 @@ dependencies = [
[[package]] [[package]]
name = "smallvec" name = "smallvec"
version = "1.11.0" version = "1.11.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "62bb4feee49fdd9f707ef802e22365a35de4b7b299de4763d44bfea899442ff9" checksum = "4dccd0940a2dcdf68d092b8cbab7dc0ad8fa938bf95787e1b916b0e3d0e8e970"
[[package]] [[package]]
name = "smol" name = "smol"
+1 -1
View File
@@ -5,7 +5,7 @@ flowchart LR
end end
FRAME -.-> ParachainRuntime FRAME -.-> ParachainRuntime
Substrate[Substrate Node Libraries] -.-> ParachainNoe Substrate[Substrate Node Libraries] -.-> ParachainNode
CumulusC[Cumulus Node Libraries] -.-> ParachainNode CumulusC[Cumulus Node Libraries] -.-> ParachainNode
CumulusR[Cumulus Runtime Libraries] -.-> ParachainRuntime CumulusR[Cumulus Runtime Libraries] -.-> ParachainRuntime
+1 -1
View File
@@ -365,7 +365,7 @@ pub mod pallet {
// ensure sender has enough balance, and if so, calculate what is left after `amount`. // ensure sender has enough balance, and if so, calculate what is left after `amount`.
let sender_balance = Balances::<T>::get(&sender).ok_or("NonExistentAccount")?; let sender_balance = Balances::<T>::get(&sender).ok_or("NonExistentAccount")?;
if sender_balance < amount { if sender_balance < amount {
return Err("InsufficientBalance".into()) return Err("InsufficientBalance".into());
} }
let reminder = sender_balance - amount; let reminder = sender_balance - amount;
+12 -11
View File
@@ -54,8 +54,8 @@
//! > high level tutorial. They should be explained in the rust-doc of the corresponding type or //! > high level tutorial. They should be explained in the rust-doc of the corresponding type or
//! > macro. //! > macro.
//! //!
//! 2. 🧘 Less is More: For reasons mentioned [above](#crate::why-rust-docs), the more concise this //! 2. 🧘 Less is More: For reasons mentioned [above](#why-rust-docs), the more concise this crate
//! crate is, the better. //! is, the better.
//! 3. √ Dont Repeat Yourself DRY: A summary of the above two points. Authors should always //! 3. √ Dont Repeat Yourself DRY: A summary of the above two points. Authors should always
//! strive to avoid any duplicate information. Every concept should ideally be documented in //! strive to avoid any duplicate information. Every concept should ideally be documented in
//! *ONE* place and one place only. This makes the task of maintaining topics significantly //! *ONE* place and one place only. This makes the task of maintaining topics significantly
@@ -69,8 +69,7 @@
//! > what topics are already covered in this crate, and how you can build on top of the information //! > what topics are already covered in this crate, and how you can build on top of the information
//! > that they already pose, rather than repeating yourself**. //! > that they already pose, rather than repeating yourself**.
//! //!
//! For more details about documenting guidelines, see: //! For more details see the [latest documenting guidelines](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/DOCUMENTATION_GUIDELINES.md).
//! <https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/DOCUMENTATION_GUIDELINES.md#L23>
//! //!
//! #### Example: Explaining `#[pallet::call]` //! #### Example: Explaining `#[pallet::call]`
//! //!
@@ -133,14 +132,16 @@
//! compromise, but in the long term, we should work towards finding a way to maintain different //! compromise, but in the long term, we should work towards finding a way to maintain different
//! revisions of this crate. //! revisions of this crate.
//! //!
//! ## How to Build //! ## How to Develop Locally
//! //!
//! To build this crate properly, with with right HTML headers injected, run: //! To view the docs specific [`crate`] locally for development, including the correct HTML headers
//! injected, run:
//! //!
//! ```no_compile //! ```sh
//! RUSTDOCFLAGS="--html-in-header $(pwd)/docs/sdk/headers/toc.html" cargo doc -p polkadot-sdk-docs //! SKIP_WASM_BUILD=1 RUSTDOCFLAGS="--html-in-header $(pwd)/docs/sdk/headers/toc.html" cargo doc -p polkadot-sdk-docs --no-deps --open
//! ``` //! ```
//! //!
//! adding `--no-deps` would speed up the process while development. If even faster build time for //! If even faster build time for docs is needed, you can temporarily remove most of the
//! docs is needed, you can temporarily remove most of the substrate/cumulus dependencies that are //! substrate/cumulus dependencies that are only used for linking purposes.
//! only used for linking purposes. //!
//! For more on local development, see [`crate::reference_docs::development_environment_advice`].