Skip to content

Commit

Permalink
Remove trailing blank lines on class docs and returnless constructor …
Browse files Browse the repository at this point in the history
…docs.
  • Loading branch information
mojombo committed Apr 23, 2011
1 parent c79ac92 commit c61e6ff
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions tomdoc.md
Expand Up @@ -210,7 +210,6 @@ but only contains the Description and Examples sections.
#
# Math.square_root(9)
# # => 3
#
module Math
...
end
Expand All @@ -232,14 +231,12 @@ Special Considerations
### Constructor

A Ruby class's `initialize` method does not have a significant return value.
You MAY exclude the returns section and SHOULD include a blank line between
the arguments section and the method. A larger description of the purpose of
You MAY exclude the returns section. A larger description of the purpose of
this class should be done at the Class level.

# Public: Initialize a Widget.
#
# name - A String naming the widget.
#
def initialize(name)
...
end
Expand All @@ -254,7 +251,6 @@ The Examples section MAY be included.
#
# Widget.new("Tom")
# # => <Widget name=Tom>
#
def initialize(name)
...
end
Expand Down

0 comments on commit c61e6ff

Please sign in to comment.