crate_public 0.1.0

First crate on rust course 1
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

/*
These lines are not going to be apart of the documentation
*/
// These comments will not be available in the documentation

//! # Basic math crate
//! This is a collection of some generally used math functions
//!
/// Computes a square of an input number
/// # Examples
/// # Tests
/// ```
/// let n = 5;
/// let answer = crate_public::square(n);
/// assert_eq!(25, answer);
/// ```
///
/// # limitations
///
/// # Some other section
pub fn square(num: i32) -> i32 {
    num * num
}

/// Computes a cube of an input number
/// # Examples
/// # Tests
/// ```
/// let n = 5;
/// let answer = crate_public::cube(n);
/// assert_eq!(125, answer);
/// ```
///
/// # limitations
///
/// # Some other section
pub fn cube(num: i32) -> i32 {
    num * num * num
}