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

Report a warning if a method summary starts with "Make sure to call this " #1155

Open

RalfKoban opened this issue Nov 22, 2024 · 0 comments

Labels

Area: analyzer Area: codefix Area: documentation feature

Owner

RalfKoban commented Nov 22, 2024 •

edited

Loading

We should report a warning if a method summary starts with Make sure to call this .

The reason is that

The <summary> probably does not describe the purpose of the method.
This belongs in a <remarks/> section.
It does not explain why to make sure to call it.

The text was updated successfully, but these errors were encountered:

RalfKoban added feature Area: analyzer Area: documentation Area: codefix labels

RalfKoban added this to MiKo Analyzers

github-project-automation bot moved this to To do in MiKo Analyzers

RalfKoban moved this from To do to Backlog in MiKo Analyzers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment