diff --git a/Cargo.lock b/Cargo.lock index 6eb5a68..52d38aa 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4,7 +4,7 @@ version = 3 [[package]] name = "linker-set" -version = "0.3.4" +version = "0.3.5" dependencies = [ "linker-set-proc", "paste", diff --git a/Cargo.toml b/Cargo.toml index 7eebf11..e4feee6 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "linker-set" -version = "0.3.4" +version = "0.3.5" edition = "2021" authors = ["Sidney Cammeresi "] license = "BSD-3-Clause" diff --git a/src/lib.rs b/src/lib.rs index d94bb7e..069357d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -38,8 +38,9 @@ //! If you make a linker set of an integer type, you should use typed //! literals, not generic integer literals. I.e. //! -//! ```no_run +//! ``` //! use linker_set::*; +//! //! set_declare!(foo, u64); //! //! #[set_entry(foo)] @@ -145,9 +146,9 @@ impl std::iter::FusedIterator for LinkerSetIter where T: 'static {} unsafe impl Send for LinkerSetIter {} -/// A proxy object that represents (but does not wrap) a linker set. +/// A proxy object that represents a linker set. /// -/// You can use this object if you should want the ability to create +/// You can store this object if you should want the ability to create /// multiple iterators on the linker set, or maybe if you wanted to keep /// track of a specific linker set out of some number of them. pub struct LinkerSet @@ -243,8 +244,7 @@ macro_rules! set_declare { }; } -/// Create a linker set proxy object. The object can be used to iterate over -/// or index into the linker set. +/// Create a linker set proxy object for iteration or indexing. #[macro_export] macro_rules! set { ($set:ident) => {{