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

Jonathan M Davis via Digitalmars-d digitalmars-d at puremagic.com
Thu Sep 22 15:44:13 PDT 2016


On Thursday, September 22, 2016 14:26:15 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.

This is what I do (and have done in Phobos). No, it's technically not the
best English, but it works quite well IMHO, and almost no one is going to
care that it's not perfect English.

- Jonathan M Davis



More information about the Digitalmars-d mailing list