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

Documentation for public functions #65

Open
tolikzinovyev opened this issue Nov 12, 2024 · 0 comments
Open

Documentation for public functions #65

tolikzinovyev opened this issue Nov 12, 2024 · 0 comments

Comments

@tolikzinovyev
Copy link
Member

Why

We should have proper documentation for each public function before presenting the library.

What

See https://github.com/cardano-scaling/alba/pull/63/files#r1837559375.

 /// Adds two numbers together.
///
/// # Arguments
///
/// * `a` - The first integer to add.
/// * `b` - The second integer to add.
///
/// # Returns
///
/// An integer that is the sum of `a` and `b`.
///
/// # Examples
///
/// ```
/// let result = add(2, 3);
/// assert_eq!(result, 5);
/// ```
@rrtoledo rrtoledo linked a pull request Nov 12, 2024 that will close this issue
9 tasks
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

Successfully merging a pull request may close this issue.

1 participant