gmt icon indicating copy to clipboard operation
gmt copied to clipboard

Formatting of modifiers and directives

Open PaulWessel opened this issue 2 years ago • 4 comments

We should strive for consistency across all the docs. My issue here is which one we prefer. In some pages we use this format: - a: This directive is for whatever, e.g.

N

while in oter places we use this format: - a - This directive is for whatever, e.g.,

b

What do you prefer? Perhaps the latter form avoids any rookie confusion about the colon, or perhaps a space between directive/modifier and colon fixes that?

PaulWessel avatar Nov 29 '23 09:11 PaulWessel

perhaps a space between directive/modifier and colon fixes that

This is my preference.

seisman avatar Nov 29 '23 11:11 seisman

I prefer the no colon at all but with a leading dash.

joa-quim avatar Nov 29 '23 12:11 joa-quim

I prefer the no colon at all but with a leading dash.

You mean the <bullet +x - explanation, i.e. second png?

PaulWessel avatar Nov 29 '23 16:11 PaulWessel

Yes.

joa-quim avatar Nov 29 '23 18:11 joa-quim