Albrecht Schlosser wrote:
> The short description should start like a sentence with an
> implicit (but elided) "This method ..." at its beginning,
> where applicable, e.g.
> - "Gets the current color."
> - "Sets the background color."
> - "Returns the last item in the Fl_Browser."
> The old docs have sentences like "Get the current color".
I follow you.
I have a feeling this is going to be hard for documenters to do,
as "Get the color" and "Gets the color" are so similar.
It's a common thing to see those stilted pseudo-sentences
in docs.
I think it's a habit programmers have trying to squeeze comments
that appear at the right of code so it doesn't scroll off the edge
of the screen.
In the 80's I used to know hard core programmers who even talked
that way, as if every spoken word was being typed and had to fit
into a 40 column screen to avoid word wrap.
One could almost hear a DECWriter carriage return at the end
of each sentence..
Hey Finnley, sure is hot outside. How's it hangin..?
Fine.
By the way, don't login to the sun.
Disk I/O errors.
Use the vax.
OK.. damn, thought they fixed that thing last week. Anything
else?
Directors meeting today.
Free donuts in the kitchen,
Coffee in the conference room.
Jellies are good.
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev
