Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Commit

Permalink
Don't compile doccomments - they are illustrative
Browse files Browse the repository at this point in the history
  • Loading branch information
tdimitrov committed Mar 23, 2022
1 parent ea45458 commit 660680b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions primitives/src/runtime_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@
//!
//! All stable API functions should use primitives from the latest version.
//! In the time of writing of this document - this is v2. So for example:
//! ```rust
//! ```ignore
//! fn validators() -> Vec<v2::ValidatorId>;
//! ```
//! indicates a function from the stable v2 API.
//!
//! On the other hand a staging function might look like this:
//! ```rust
//! ```ignore
//! fn get_session_disputes() -> Vec<(vstaging::SessionIndex, vstaging::CandidateHash, vstaging::DisputeState<vstaging::BlockNumber>)>;
//! ```
//! or this:
//! ```rust
//! ```ignore
//! fn unstable_get_session_disputes() -> Vec<(vstaging::SessionIndex, vstaging::CandidateHash, vstaging::DisputeState<vstaging::BlockNumber>)>;
//! ```
//! In the second example the function is prefixed with `unstable_`. This
Expand All @@ -43,7 +43,7 @@
//!
//! Once a staging function is ready to be versioned the `changed_in` macro
//! can be used to rename it and version it. For the example above:
//! ```rust
//! ```ignore
//! fn get_session_disputes() -> Vec<(v3::SessionIndex, v3::CandidateHash, v3::DisputeState<v3::BlockNumber>)>;
//!
//! #[changed_in(2)]
Expand Down

0 comments on commit 660680b

Please sign in to comment.