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

Show a opt-in warning for undocumented open / public code blocks #5974

Open
2 tasks done
CodebyCR opened this issue Jan 20, 2025 · 1 comment
Open
2 tasks done

Show a opt-in warning for undocumented open / public code blocks #5974

CodebyCR opened this issue Jan 20, 2025 · 1 comment
Labels
help Questions or user problems that require more explanation rather than code changes.

Comments

@CodebyCR
Copy link

New Issue Checklist

Feature or Enhancement Proposal

Note

In the text below, code blocks means classes, structs, actors, protocols, enums, and methods.

Show a opt-in warning for undocumented open / public code blocks

This could increase the frequency of documented code that you want to share with other developers.

For example, imagine you've written a Swift package that you want to make publicly available. You want to document all the methods
that users of your package can use. These are all open and public code blocks.

Now imagine your package has more than 150 files.
It could easily happen that you forget to document some of your public or open code blocks.
But if you use an opt-in warning for this, you can step through your warnings to fix them.

@SimplyDanny
Copy link
Collaborator

What about the missing_docs rule?

@SimplyDanny SimplyDanny added the help Questions or user problems that require more explanation rather than code changes. label Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help Questions or user problems that require more explanation rather than code changes.
Projects
None yet
Development

No branches or pull requests

2 participants