tomdoc

tomdoc copied to clipboard

When navigating to http://tomdoc.org/ a 404 error is displayed.

James-Hopkins

tomdoc.org is down

5

I get a 404 when I try to go there right now.

phred

please update tomdoc.org

1

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...

nefariousphd

Description of Examples

1

I would like to add some lines of description to each example in the Examples section, however, that seems to violate the format, and the description becomes an example of...

maasha

Link to RFC 2119

2

jayschwa

Downplay Examples

2

I think the Examples section should be downplayed a bit. What I mean by that is, I have found the my documentation is usually more readable when examples are given...

trans

Add signature section.

11

Proposed solution to metaprogramming.

mojombo

Code SHOULD be indented three spaces.

1

I'm guessing this was intended to be an RFC 2119 "SHOULD"?

Peeja

All the examples show a blank line separating sections but this isn't covered by the spec. Is it entirely optional or should this be part of the spec?

Haegin

To me a signature is something to describe alternate arguments, not dynamic method definitions. For example: ``` ruby # Public: Find all of something. # # Signatures # # find_all(name)...

trans