Missing top-level documentation comment RB-ST1031
Documentation
Minor
3 years ago
—
4 years old
Missing top-level class documentation comment.
8puts 'Your unsorted numbers'
9p array
10
11class MergeSort12 class << self
13 def sort(array)
14 return array if array.size <= 1Missing top-level class documentation comment.
8puts 'Your unsorted numbers'
9p array
10
11class BubbleSort12 class << self
13 def sort(array)
14 return array if array.size <= 1
Description
Top-level documentation comment should be included in classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.
The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.
Bad practice
class Person
# ...
end
Recommended
# Description/Explanation of Person class
class Person
# ...
end