SwiftLint icon indicating copy to clipboard operation
SwiftLint copied to clipboard

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

Open CodebyCR opened this issue 9 months ago • 2 comments
trafficstars

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.

CodebyCR avatar Jan 20 '25 10:01 CodebyCR

What about the missing_docs rule?

SimplyDanny avatar Jan 20 '25 12:01 SimplyDanny

This issue has been marked as stale because it has not seen any activity in the last 4 months. It is going to be closed soon if it stays inactive.

github-actions[bot] avatar Jun 15 '25 00:06 github-actions[bot]

This issue is being closed due to inactivity. Please feel free to reopen if you have more information.

github-actions[bot] avatar Aug 15 '25 00:08 github-actions[bot]