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

Require doc strings #129

Open
obycode opened this issue Oct 19, 2023 · 0 comments
Open

Require doc strings #129

obycode opened this issue Oct 19, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@obycode
Copy link
Collaborator

obycode commented Oct 19, 2023

Following up on @Acaccia's comment in my PR, I agree we should enforce the docstrings. It's probably a good idea to require them on private functions too. It looks like rustc supports #![warn(missing_docs)] to warn on public items missing docs. I also see these options in clippy that seem like a good idea to enable:

Once this is enabled, we should also utilize GitHub docs to generate and publish the docs with each push to main.

@obycode obycode added the documentation Improvements or additions to documentation label Oct 19, 2023
@github-project-automation github-project-automation bot moved this to Status: 🆕 New in Stacks Core Eng Oct 19, 2023
@obycode obycode moved this from Status: 🆕 New to Status: 📋 Backlog in Stacks Core Eng Oct 19, 2023
@smcclellan smcclellan added this to the WASM Phase 3 milestone Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Status: 📋 Backlog
Development

No branches or pull requests

2 participants