Skip to content

Commit

Permalink
Remove rustdocs allowances (#2797)
Browse files Browse the repository at this point in the history
  • Loading branch information
juangirini committed Dec 24, 2023
1 parent 8acd630 commit b4c8166
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 13 deletions.
2 changes: 0 additions & 2 deletions docs/sdk/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@
//!
//! This section paints a picture over the high-level information architecture of this crate.
#![doc = simple_mermaid::mermaid!("../../mermaid/IA.mmd")]
#![allow(rustdoc::invalid_html_tags)] // TODO: remove later. https://github.com/paritytech/polkadot-sdk-docs/issues/65
#![allow(rustdoc::bare_urls)] // TODO: remove later. https://github.com/paritytech/polkadot-sdk-docs/issues/65
#![warn(rustdoc::broken_intra_doc_links)]
#![warn(rustdoc::private_intra_doc_links)]

Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/src/polkadot_sdk/polkadot.rs
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
//! correct execution of all parachain, without having all of its validators re-execute all
//! parachain blocks. When seen from this perspective, the fact that Polkadot executes different
//! parachains means it is a platform that has fully delivered (the holy grail of) "Full Execution
//! Sharding". TODO: link to approval checking article. https://github.com/paritytech/polkadot-sdk-docs/issues/66
//! Sharding". TODO: link to approval checking article. <https://github.com/paritytech/polkadot-sdk-docs/issues/66>
//! * A framework to build blockchains: In order to materialize the ecosystem of parachains, an easy
//! blockchain framework must exist. This is [Substrate](crate::polkadot_sdk::substrate),
//! [FRAME](crate::polkadot_sdk::frame_runtime) and [Cumulus](crate::polkadot_sdk::cumulus).
Expand All @@ -60,7 +60,7 @@
//!
//! > Note that the interoperability promised by Polkadot is unparalleled in that any two parachains
//! > connected to Polkadot have the same security and can have much better guarantees about the
//! > security of the recipient of any message. TODO: weakest link in bridges systems. https://github.com/paritytech/polkadot-sdk-docs/issues/66
//! > security of the recipient of any message. TODO: weakest link in bridges systems. <https://github.com/paritytech/polkadot-sdk-docs/issues/66>
//!
//! Polkadot delivers the above vision, alongside a flexible means for parachains to schedule
//! themselves with the Relay Chain. To achieve this, Polkadot has been developed with an
Expand All @@ -84,4 +84,4 @@
//! - RFC#5: [Coretime-interface](https://github.com/polkadot-fellows/RFCs/blob/main/text/0005-coretime-interface.md):
//! Interface for manipulating the usage of cores on the Polkadot Ubiquitous Computer.
// TODO: add more context and explanations about Polkadot as the Ubiquitous Computer and related
// tech. https://github.com/paritytech/polkadot-sdk-docs/issues/66
// tech. <https://github.com/paritytech/polkadot-sdk-docs/issues/66>
4 changes: 2 additions & 2 deletions docs/sdk/src/polkadot_sdk/smart_contracts.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
//! # Smart Contracts
//!
//! TODO: @cmichi https://github.com/paritytech/polkadot-sdk-docs/issues/56
//! TODO: @cmichi <https://github.com/paritytech/polkadot-sdk-docs/issues/56>
//!
//! - WASM and EVM based, pallet-contracts and pallet-evm.
//! - single-daap-chain, transition from ink! to FRAME.
//! - Link to `use.ink`
//! - Link to [`crate::reference_docs::runtime_vs_smart_contract`].
//! - https://use.ink/migrate-ink-contracts-to-polkadot-frame-parachain/
//! - <https://use.ink/migrate-ink-contracts-to-polkadot-frame-parachain/>
2 changes: 1 addition & 1 deletion docs/sdk/src/polkadot_sdk/substrate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@
//! - [`sc_consensus_aura`]
//! - [`sc_consensus_babe`]
//! - [`sc_consensus_grandpa`]
//! - [`sc_consensus_beefy`] (TODO: @adrian, add some high level docs https://github.com/paritytech/polkadot-sdk-docs/issues/57)
//! - [`sc_consensus_beefy`] (TODO: @adrian, add some high level docs <https://github.com/paritytech/polkadot-sdk-docs/issues/57>)
//! - [`sc_consensus_manual_seal`]
//! - [`sc_consensus_pow`]

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/src/polkadot_sdk/xcm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
//!
//! @KiChjang @franciscoaguirre
//! TODO: RFCs, xcm-spec, the future of the repo, minimal example perhaps, forward to where actual
//! docs are hosted. https://github.com/paritytech/polkadot-sdk-docs/issues/58
//! docs are hosted. <https://github.com/paritytech/polkadot-sdk-docs/issues/58>
2 changes: 1 addition & 1 deletion docs/sdk/src/reference_docs/frame_benchmarking_weight.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@
//! - how to write benchmarks, how you must think of worst case.
//! - how to run benchmarks.
//!
//! - https://www.shawntabrizi.com/substrate/substrate-storage-deep-dive/
//! - <https://www.shawntabrizi.com/substrate/substrate-storage-deep-dive/>
2 changes: 1 addition & 1 deletion docs/sdk/src/reference_docs/frame_currency.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
//! - History, `Currency` trait.
//! - `Hold` and `Freeze` with diagram.
//! - `HoldReason` and `FreezeReason`
//! - This footgun: https://github.com/paritytech/polkadot-sdk/pull/1900#discussion_r1363783609
//! - This footgun: <https://github.com/paritytech/polkadot-sdk/pull/1900#discussion_r1363783609>
4 changes: 2 additions & 2 deletions docs/sdk/src/reference_docs/light_nodes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
//!
//! Notes: should contain only high level information about light clients, then link to how to set
//! it up in PAPI and SubXT
//! https://docs.substrate.io/learn/light-clients-in-substrate-connect/
//! https://github.com/substrate-developer-hub/substrate-front-end-template/pull/277
//! <https://docs.substrate.io/learn/light-clients-in-substrate-connect/>
//! <https://github.com/substrate-developer-hub/substrate-front-end-template/pull/277>

0 comments on commit b4c8166

Please sign in to comment.