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.

Sign up for GitHub

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

Jump to bottom

[Feature]: Document openzeppelin-crypto Functions #519

Open
1 task done
0xNeshi opened this issue Jan 30, 2025 · 0 comments
Open
1 task done

[Feature]: Document openzeppelin-crypto Functions #519

0xNeshi opened this issue Jan 30, 2025 · 0 comments
Labels
good first issue Good for newcomers. priority: 0 Nice-to-have. Willing to ship without this. tracking Umbrella issue that tracks some work. type: docs Changes to documentation.

Comments

@0xNeshi
Copy link
Collaborator

0xNeshi commented Jan 30, 2025

What is the feature you would like to see?

Related #495

There are many functions, pub and pub(crate) ones, without any doc comments. Each of them should at least include a doc comment explaining what they're doing for easier future maintenance.

As this is an umbrella issue, any PR that includes additional docs for these functions can just link to this issue.

Contribution Guidelines

  • I agree to follow this project's Contribution Guidelines
@0xNeshi 0xNeshi added good first issue Good for newcomers. priority: 0 Nice-to-have. Willing to ship without this. tracking Umbrella issue that tracks some work. type: docs Changes to documentation. labels Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers. priority: 0 Nice-to-have. Willing to ship without this. tracking Umbrella issue that tracks some work. type: docs Changes to documentation.
Projects
Rust Contracts Stylus
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
1 participant
@0xNeshi