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

Outer Documentation Comments #32

Open
rkdud007 opened this issue Dec 21, 2023 · 0 comments
Open

Outer Documentation Comments #32

rkdud007 opened this issue Dec 21, 2023 · 0 comments

Comments

@rkdud007
Copy link
Member

rkdud007 commented Dec 21, 2023

For better readability and usage for potential developers who might utilize accumulator library + also for inner documentation purpose, need to update all the outer/inner documentation comments by refer to top tier rust opensource library projects.

For simple example, every public functions should have like the comment below:

/// Adds two numbers together.
///
/// # Arguments
///
/// * `x` - The first number to add.
/// * `y` - The second number to add.
///
/// # Examples
///
/// ```
/// let result = add(2, 3);
/// assert_eq!(result, 5);
/// ```
///
/// # Returns
///
/// This function returns the sum of `x` and `y`.
///
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant