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

Introduce CI check for non-documented code #694

Open
igamigo opened this issue Jan 25, 2025 · 0 comments
Open

Introduce CI check for non-documented code #694

igamigo opened this issue Jan 25, 2025 · 0 comments

Comments

@igamigo
Copy link
Collaborator

igamigo commented Jan 25, 2025

As the client continues to grow, we want to make sure it's as well documented as possible.
It would make sense to introduce a tool to check whether we are committing undocumented code (possibly both here and in miden-base as well since we re-export various structs from there).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@igamigo