Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add rustfmt.toml to format Rust code in doc comments #155

Merged
merged 1 commit into from
Mar 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions rustfmt.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
format_code_in_doc_comments = true
2 changes: 1 addition & 1 deletion src/int.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
//!
//! # Example
//! ```rust
//! use std::ops::{Add, Sub, Mul, Div, Rem};
//! use std::ops::{Add, Div, Mul, Rem, Sub};
//! use typenum::{Integer, N3, P2};
//!
//! assert_eq!(<N3 as Add<P2>>::Output::to_i32(), -1);
Expand Down
5 changes: 2 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
//! example,
//!
//! ```rust
//! use typenum::{N4, Integer};
//! use typenum::{Integer, N4};
//!
//! assert_eq!(N4::to_i32(), -4);
//! ```
Expand All @@ -34,14 +34,13 @@
//! could be replaced with
//!
//! ```rust
//! use typenum::{Sum, Integer, P3, P4};
//! use typenum::{Integer, Sum, P3, P4};
//!
//! type X = Sum<P3, P4>;
//! assert_eq!(<X as Integer>::to_i32(), 7);
//! ```
//!
//! Documented in each module is the full list of type operators implemented.
//!

#![no_std]
#![forbid(unsafe_code)]
Expand Down
10 changes: 5 additions & 5 deletions src/marker_traits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
//! to_i32() -> i32` and the associated constant `I32` so that one can do this:
//!
//! ```
//! use typenum::{N42, Integer};
//! use typenum::{Integer, N42};
//!
//! assert_eq!(-42, N42::to_i32());
//! assert_eq!(-42, N42::I32);
Expand Down Expand Up @@ -49,7 +49,7 @@ pub trait Bit: Copy + Default {
///
/// # Example
/// ```rust
/// use typenum::{U3, Unsigned};
/// use typenum::{Unsigned, U3};
///
/// assert_eq!(U3::to_u32(), 3);
/// assert_eq!(U3::I32, 3);
Expand Down Expand Up @@ -118,7 +118,7 @@ pub trait Unsigned: Copy + Default {
///
/// # Example
/// ```rust
/// use typenum::{P3, Integer};
/// use typenum::{Integer, P3};
///
/// assert_eq!(P3::to_i32(), 3);
/// assert_eq!(P3::I32, 3);
Expand Down Expand Up @@ -171,9 +171,9 @@ pub trait TypeArray {}
/// Here's a working example:
///
/// ```rust
/// use typenum::{P4, P8, PowerOfTwo};
/// use typenum::{PowerOfTwo, P4, P8};
///
/// fn only_p2<P: PowerOfTwo>() { }
/// fn only_p2<P: PowerOfTwo>() {}
///
/// only_p2::<P4>();
/// only_p2::<P8>();
Expand Down
8 changes: 4 additions & 4 deletions src/type_operators.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use {Bit, NInt, NonZero, PInt, UInt, UTerm, Unsigned, Z0};
///
/// # Example
/// ```rust
/// use typenum::{Same, U4, U5, Unsigned};
/// use typenum::{Same, Unsigned, U4, U5};
///
/// assert_eq!(<U5 as Same<U5>>::Output::to_u32(), 5);
///
Expand All @@ -38,7 +38,7 @@ impl<T> Same<T> for T {
///
/// # Example
/// ```rust
/// use typenum::{Abs, N5, Integer};
/// use typenum::{Abs, Integer, N5};
///
/// assert_eq!(<N5 as Abs>::Output::to_i32(), 5);
/// ```
Expand All @@ -63,7 +63,7 @@ impl<U: Unsigned + NonZero> Abs for NInt<U> {
///
/// # Example
/// ```rust
/// use typenum::{Pow, N3, P3, Integer};
/// use typenum::{Integer, Pow, N3, P3};
///
/// assert_eq!(<N3 as Pow<P3>>::Output::to_i32(), -27);
/// ```
Expand Down Expand Up @@ -550,7 +550,7 @@ pub trait Logarithm2 {
/// # Example
///
/// ```rust
/// use typenum::{Gcd, U12, U8, Unsigned};
/// use typenum::{Gcd, Unsigned, U12, U8};
///
/// assert_eq!(<U12 as Gcd<U8>>::Output::to_i32(), 4);
/// ```
Expand Down
4 changes: 2 additions & 2 deletions src/uint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
//!
//! # Example
//! ```rust
//! use std::ops::{BitAnd, BitOr, BitXor, Shl, Shr, Add, Sub, Mul, Div, Rem};
//! use std::ops::{Add, BitAnd, BitOr, BitXor, Div, Mul, Rem, Shl, Shr, Sub};
//! use typenum::{Unsigned, U1, U2, U3, U4};
//!
//! assert_eq!(<U3 as BitAnd<U2>>::Output::to_u32(), 2);
Expand Down Expand Up @@ -146,7 +146,7 @@ impl Unsigned for UTerm {
///
/// # Example
/// ```rust
/// use typenum::{B0, B1, UInt, UTerm};
/// use typenum::{UInt, UTerm, B0, B1};
///
/// # #[allow(dead_code)]
/// type U6 = UInt<UInt<UInt<UTerm, B1>, B1>, B0>;
Expand Down