[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
other manual style issues
From: |
Graham Percival |
Subject: |
other manual style issues |
Date: |
Sun, 12 Sep 2004 22:08:09 -0700 |
Ok, now that the silly gender issues have their own thread, let's
discuss real issues.
I have one request for 2-space tabs for examples in the manual. I'm
happy with this. Any objections?
Punctuation before an example: if we have a small amount of text, I'm
content to have the text flow directly into the example (ie no period).
But if we've got a whole paragraph before the example, I'd really like
to end the last sentence (ie add a period). I agree that we shouldn't
have any colons or commas before an example, but IMO if we have a full
sentence at the end of a long paragraph, we should include a full stop.
Doing otherwise looks quite weird
----------
---o-----
---|------
---|------
----------
Doesn't that last paragraph look weird without a period at the end of
the final sentence?
In contrast, consider the following example
-----------
---|-------
---|-------
---o------
-----------
The second example works; the first does not. IMNSHO, of course. :)
Cheers,
- Graham
- other manual style issues,
Graham Percival <=