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

XML documentation should not contain term "Fire" #29

Closed
RalfKoban opened this issue Feb 9, 2018 · 1 comment
Closed

XML documentation should not contain term "Fire" #29

RalfKoban opened this issue Feb 9, 2018 · 1 comment
Labels
Area: analyzer Area: documentation feature

Comments

@RalfKoban
Copy link
Owner

The term Fire is negative. Employees get fired, guns get fired but no code.
Most times the term is used for events that get raised.
So terms like fire, fires, fired should be replaced by raise.
For exceptions it should be thrown.

Exception: Term is Firewall
RalfKoban added a commit that referenced this issue Feb 14, 2018
@RalfKoban
Unfinished preparation for #29
4f3a12a
@RalfKoban
Copy link
Owner Author

also consider firing

@RalfKoban RalfKoban changed the title Documentation should not contain term "Fire" XML documentation should not contain term "Fire" Mar 7, 2018
RalfKoban added a commit that referenced this issue Apr 5, 2018
@RalfKoban
Part of #29
a873fa1
@ghost ghost removed the in progress label Apr 5, 2018
RalfKoban added a commit that referenced this issue Apr 5, 2018
@RalfKoban
Small addition for #29
2fff73f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Area: analyzer Area: documentation feature
Projects
MiKo Analyzers
Status: Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@RalfKoban