From a7a0121b095376e4cb6c1e6908cd7bf89ae15c61 Mon Sep 17 00:00:00 2001 From: Robert Habermeier Date: Thu, 17 Jan 2019 18:07:54 -0300 Subject: [PATCH] mark GRANDPA and consensus stuff as unstable (#1469) --- substrate/core/consensus/common/src/block_import.rs | 2 -- substrate/core/consensus/common/src/lib.rs | 6 +++++- substrate/core/finality-grandpa/src/lib.rs | 2 ++ 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/substrate/core/consensus/common/src/block_import.rs b/substrate/core/consensus/common/src/block_import.rs index f4a60d435d..a683bc3019 100644 --- a/substrate/core/consensus/common/src/block_import.rs +++ b/substrate/core/consensus/common/src/block_import.rs @@ -137,8 +137,6 @@ impl ImportBlock { } } - - /// Block import trait. pub trait BlockImport { type Error: ::std::error::Error + Send + 'static; diff --git a/substrate/core/consensus/common/src/lib.rs b/substrate/core/consensus/common/src/lib.rs index 23bde0c056..453b684430 100644 --- a/substrate/core/consensus/common/src/lib.rs +++ b/substrate/core/consensus/common/src/lib.rs @@ -14,7 +14,11 @@ // You should have received a copy of the GNU General Public License // along with Substrate Consensus Common. If not, see . -//! Tracks offline validators. +//! Common utilities for building and using consensus engines in substrate. +//! +//! Much of this crate is _unstable_ and thus the API is likely to undergo +//! change. Implementors of traits should not rely on the interfaces to remain +//! the same. // This provides "unused" building blocks to other crates #![allow(dead_code)] diff --git a/substrate/core/finality-grandpa/src/lib.rs b/substrate/core/finality-grandpa/src/lib.rs index aacee8fe7d..54833f2880 100644 --- a/substrate/core/finality-grandpa/src/lib.rs +++ b/substrate/core/finality-grandpa/src/lib.rs @@ -16,6 +16,8 @@ //! Integration of the GRANDPA finality gadget into substrate. //! +//! This crate is unstable and the API and usage may change. +//! //! This crate provides a long-running future that produces finality notifications. //! //! # Usage