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

[Marco Leise via Digitalmars-d]

Am Thu, 22 Sep 2016 14:26:15 -0400
schrieb Andrei Alexandrescu <SeeWebsiteForEmail at erdani.org>:

> Consider e.g. 
> http://dtest.thecybershadow.net/artifact/website-ff971425e306789aa308cfb07cba092cadd11161-d41523308b293d6e0a3d6da971a68db8/web/phobos-prerelease/std_algorithm_sorting.html#pivotPartition, 
> where we can see the parameters table and the returns subsection.
> 
> How to formulate these lingustically?

You are not the only one scratching his head. I went through
the same stages, from full sentence over removing repeated
words, to lowercase without punctuation. /Currently/ I'm using:

  Returns:
    pointer to the parent object; maybe `null` if this is the
    root object

Anything needing a long explanation then needs to be written
in a way that it refers to the description paragraph(s) above
in brief. Happy bike-shedding :)

-- 
Marco