Skip to content

Commit

Permalink
misc. doc updates and fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
joseluis committed Nov 25, 2024
1 parent 11d45bb commit 8eff813
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@ dep_unicode_width = ["dep:unicode-width"]
dep_wide = ["dep:wide"]


[dependencies] # 20 (2 required, 18 optional)
[dependencies] # 20 (2 required, 17 optional)
# https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html
# ==============================================================================
# Links to each crate's crates.io page are provided alongside the entries,
Expand Down
2 changes: 1 addition & 1 deletion src/code/macros/cdbg.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
//! Custom debug macro.
//

/// *`c`ustomizable [`dbg!`]* macro.
/// *`c`ustomizable [`dbg!`]* macro. Concise by default
///
/// - By default uses `{:?}` instead of `{:#?}` for formatting.
/// - By default doesn't show the location (file, line and column).
Expand Down
4 changes: 4 additions & 0 deletions src/code/macros/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
//
//! Utility macros
//
// # Documentation for declarative macros
// - [The Little Book of Rust Macros](https://veykril.github.io/tlborm/decl-macros.html)
// - [Macros By Example](https://doc.rust-lang.org/reference/macros-by-example.html)
// - [Specification](https://doc.rust-lang.org/reference/macro-ambiguity.html)

// private
mod _doc;
Expand Down
4 changes: 2 additions & 2 deletions src/code/reexports.rs
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ doc: "An attempted conversion that consumes self, which may or may not be expens

// functions
reexport! { rust: core::convert,
doc: "The identity function.", identity }
doc: "The identity function. Just returns back its input.", identity }

/* `core::default` re-exports */

Expand All @@ -100,7 +100,7 @@ pub use core::default::Default;
/* `core::hint` re-exports */

reexport! { rust: core::hint,
doc: "Makes a *soundness* promise to the compiler that `cond` holds.", assert_unchecked }
doc: "Makes a *soundness* promise to the compiler that the `cond`ition holds.", assert_unchecked }
reexport! { rust: core::hint,
doc: "Hints the compiler to be maximally pessimistic about what black_box could do.", black_box }
reexport! { rust: core::hint,
Expand Down
2 changes: 1 addition & 1 deletion src/error/reexports.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

#![allow(unused_imports)]

use crate::code::reexport;
use crate::reexport;

/* from other modules */

Expand Down

0 comments on commit 8eff813

Please sign in to comment.