[OT] Punctuation of "Params:" and "Returns:"

[H. S. Teoh via Digitalmars-d]

On Thu, Sep 22, 2016 at 02:26:15PM -0400, Andrei Alexandrescu via Digitalmars-d wrote:
[...]
> ====
> Parameters:
> r | The range subject to partitioning.
> 
> Returns:
> Something awesome.
> ====
> 
> This is incorrect because one is not supposed to punctuate sentence
> fragments as full sentences.
[...]

I personally prefer this version. I don't think it's incorrect. (Even if
it is, does it really matter? The intended meaning is clear, and
formatting it as a full sentence looks better.)


T

-- 
If you want to solve a problem, you need to address its root cause, not just its symptoms. Otherwise it's like treating cancer with Tylenol...