Skip to content

Improve documentation for checked_* and intrinsics #19468

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.

Sign up for GitHub

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

Merged
alexcrichton merged 2 commits into from
Dec 5, 2014
Merged

Improve documentation for checked_* and intrinsics #19468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6182084
Improve documentation of checked_* functions
victorvde Dec 2, 2014
d8c5269
Update comment to current file path for intrinsics
victorvde Dec 2, 2014
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
2 changes: 1 addition & 1 deletion src/libcore/intrinsics.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

//! rustc compiler intrinsics.
//!
//! The corresponding definitions are in librustc/middle/trans/foreign.rs.
//! The corresponding definitions are in librustc_trans/trans/intrinsic.rs.
//!
//! # Volatiles
//!
Expand Down
8 changes: 4 additions & 4 deletions src/libcore/num/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ pub trait Int
/// ```
fn checked_add(self, other: Self) -> Option<Self>;

/// Checked integer subtraction. Computes `self + other`, returning `None`
/// Checked integer subtraction. Computes `self - other`, returning `None`
/// if underflow occurred.
///
/// # Example
Expand All @@ -297,7 +297,7 @@ pub trait Int
/// ```
fn checked_sub(self, other: Self) -> Option<Self>;

/// Checked integer multiplication. Computes `self + other`, returning
/// Checked integer multiplication. Computes `self * other`, returning
/// `None` if underflow or overflow occurred.
///
/// # Example
Expand All @@ -310,8 +310,8 @@ pub trait Int
/// ```
fn checked_mul(self, other: Self) -> Option<Self>;

/// Checked integer division. Computes `self + other` returning `None` if
/// `self == 0` or the operation results in underflow or overflow.
/// Checked integer division. Computes `self / other`, returning `None` if
/// `other == 0` or the operation results in underflow or overflow.
///
/// # Example
///
Expand Down