discussion: rule - operation description triggers when operation has a summary instead of a description about vacuum

[daveshanley]

I am open to suggestions; I added this rule because there is a chronic lack of descriptions in most specs. I want to ensure there is a check for descriptions. However, it may not need to remain a warning, it could be downgraded to info.

What would you expect from this rule if you were to define its behavior?

[TristanSpeakEasy]

For me personally if both summary and description were missing then it would warn, but if summary is provided and description is missing its just an info level alert that providing a description would help even more with documentation.

[daveshanley]

OK, that works for me. I will update the rule for the next release. Thank you for making vacuum better.

[daveshanley]

After thinking about this a little more, I made the following change: The rule will fire if there is no description AND no summary
if there is no description, but a summary is supplied, then the rule won't fire.

This is because different people use description and summary differently; some lean on one, and others lean on the other. There is no way to force people to do one or the other, so now the rule is more flexible, only to get upset if both are left out.

This update is available in v0.0.37