Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.57 KB

SA1629.md

File metadata and controls

41 lines (28 loc) · 1.57 KB

Rule suppression decision

Meeting

Date for meeting

11-02-2021

ATC Core members in meeting

Rule summary

Value
Title SA1629DocumentationTextMustEndWithAPeriod
CheckId SA1629
Category Documentation Rules
Link https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1629.md

What is the problem

Issue #28

Decision

We update the root/.editorconfig with severity = none and a doc-link.

Reason & arguments

  • This rule forms good practice for how to end end with a full stop. But it is not always true that it makes sense, as the example where we have a href link, then a full stop will just make noise. Therefore, we open up for freedom and place the responsibility on the person who writes documentation, to finish the song text in the best possible way.