search

mojombo / tomdoc

A flexible code documentation specification with human readers in mind.
333 stars 47 forks source link

please update tomdoc.org #52

Open nefariousphd opened 9 years ago

nefariousphd commented 9 years ago

The text at tomdoc.org and here at https://github.com/mojombo/tomdoc/blob/master/tomdoc.md are not the same (despite having the same semantic version number--grrr).

Specifically, the final paragraph of the Return/Raises section. tomdoc.org:

Lines SHOULD be wrapped at 80 columns. Wrapped lines MUST be indented under the above line by at least two spaces. For example:

here:

Lines SHOULD be wrapped at 80 columns. Wrapped lines MUST be indented, as a block, under the parent line by at least two spaces. For example:

The content here is clearer and makes more sense. Please update tomdoc.org. (There may be other differences, too; I haven't done a diff.) Thanks for helping make code clearer!

jazzpi commented 9 years ago

I think tomdoc.org follows defunkt/tomdoc, not this one.