Skip to content

Commit

Permalink
a few tweaks to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cammeresi committed Aug 3, 2024
1 parent 83b5c5b commit e6cd76f
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "linker-set"
version = "0.3.4"
version = "0.3.5"
edition = "2021"
authors = ["Sidney Cammeresi <[email protected]>"]
license = "BSD-3-Clause"
Expand Down
10 changes: 5 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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)]
Expand Down Expand Up @@ -145,9 +146,9 @@ impl<T> std::iter::FusedIterator for LinkerSetIter<T> where T: 'static {}

unsafe impl<T: Send> Send for LinkerSetIter<T> {}

/// 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<T>
Expand Down Expand Up @@ -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) => {{
Expand Down

0 comments on commit e6cd76f

Please sign in to comment.