Quaternions/arrayvec
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DOC: Update docs for debug assertions

Browse Source
This commit is contained in:
bluss
2017-07-30 14:33:49 +02:00
parent 707ddc3224
commit 4d7887010e
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/lib.rs
+5 -4
View File
@@ -170,8 +170,8 @@ impl<A: Array> ArrayVec<A> {
/// Push `element` to the end of the vector. /// Push `element` to the end of the vector.
/// ///
/// Return `None` if the push succeeds, or and return `Some(` *element* `)` /// Return `Ok` if the push succeeds, or and return an error if the vector
/// if the vector is full. /// is full.
/// ///
/// ``` /// ```
/// use arrayvec::ArrayVec; /// use arrayvec::ArrayVec;
@@ -207,7 +207,7 @@ impl<A: Array> ArrayVec<A> {
/// It is up to the caller to ensure the capacity of the vector is /// It is up to the caller to ensure the capacity of the vector is
/// sufficiently large. /// sufficiently large.
/// ///
/// # Examples /// May use debug assertions to check that the arrayvec is not full.
/// ///
/// ``` /// ```
/// use arrayvec::ArrayVec; /// use arrayvec::ArrayVec;
@@ -460,7 +460,8 @@ impl<A: Array> ArrayVec<A> {
/// Set the vector's length without dropping or moving out elements /// Set the vector's length without dropping or moving out elements
/// ///
/// May panic if `length` is greater than the capacity. /// May use debug assertions to check that `length` is not greater than the
/// capacity.
/// ///
/// This function is `unsafe` because it changes the notion of the /// This function is `unsafe` because it changes the notion of the
/// number of “valid” elements in the vector. Use with care. /// number of “valid” elements in the vector. Use with care.