fix(doc): Inline documentation of re-exports (#560)

bluealloy · Jul 28, 2023 · 30bfa73 · 30bfa73
1 parent 36de35b
commit 30bfa73
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/crates/interpreter/src/lib.rs b/crates/interpreter/src/lib.rs
@@ -21,4 +21,5 @@ pub use instructions::opcode::{self, OpCode, OPCODE_JUMPMAP};
 pub use interpreter::*;
 pub use interpreter::{BytecodeLocked, Contract, Interpreter, Memory, Stack};
 
+#[doc(inline)]
 pub use revm_primitives as primitives;
diff --git a/crates/precompile/src/lib.rs b/crates/precompile/src/lib.rs
@@ -12,6 +12,7 @@ pub use primitives::{
     precompile::{PrecompileError as Error, *},
     Bytes, HashMap,
 };
+#[doc(inline)]
 pub use revm_primitives as primitives;
 
 pub type B160 = [u8; 20];

diff --git a/crates/revm/src/lib.rs b/crates/revm/src/lib.rs
@@ -19,13 +19,16 @@ pub use journaled_state::{JournalEntry, JournaledState};
 
 extern crate alloc;
 
-/// reexport `revm_precompiles`
+// reexport `revm_precompiles`
+#[doc(inline)]
 pub use revm_precompile as precompile;
 
 // reexport `revm_interpreter`
+#[doc(inline)]
 pub use revm_interpreter as interpreter;
 
 // reexport `revm_primitives`
+#[doc(inline)]
 pub use revm_interpreter::primitives;
 
 /// Reexport Inspector implementations