Document the code

[alekay2200]

Document all the code, docstrings and document to use rust doc

[mfrandev]

Hi, I saw this project advertised on LinkedIn and want to contribute. If this issue isn't resolved yet, I'd like to do this task to gain familiarity with your implementation, then work on other issues.

[alekay2200]

Hi, thanks for be interested in my project, the issue is still open. Since the description of the issue can be not clear or misspelled I'll let you a few explanation.

The idea is to document each function and include a documentation test if the function is not complex enough, for instance:

/// This function returns the sum of to integers.
///
/// # Example
///
/// ```
/// let res = sum(3, 5);
/// assert_eq!(res, 8);
/// ```
fn sum(a: i32, b: i32) -> i32 {
    a + b
}

Also document each structure:

#[doc = "Represents a circle with a given radius."]
struct Circle {
    radius: f64,
}

Feel free to contact me if you have any doubts, thanks.