Drop :nodoc: options from core classes that contains methods with docs (#322)

soutaro · web-flow · commit bc11345b0f7e · 2024-11-27T14:15:38.000+09:00
I found some methods are not included in RDoc output, and the `:nodoc:` option should be the reason. It seems like there is no reason to opt-out the methods. 7b79bec added the option, but still not clear why we needed it.
diff --git a/lib/csv/core_ext/array.rb b/lib/csv/core_ext/array.rb
@@ -1,4 +1,4 @@
-class Array # :nodoc:
+class Array
   # Equivalent to CSV::generate_line(self, options)
   #
   #   ["CSV", "data"].to_csv
diff --git a/lib/csv/core_ext/string.rb b/lib/csv/core_ext/string.rb
@@ -1,4 +1,4 @@
-class String # :nodoc:
+class String
   # Equivalent to CSV::parse_line(self, options)
   #
   #   "CSV,data".parse_csv

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-class Array # :nodoc:`
	`1`	`+class Array`
`2`	`2`	`# Equivalent to CSV::generate_line(self, options)`
`3`	`3`	`#`
`4`	`4`	`# ["CSV", "data"].to_csv`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-class String # :nodoc:`
	`1`	`+class String`
`2`	`2`	`# Equivalent to CSV::parse_line(self, options)`
`3`	`3`	`#`
`4`	`4`	`# "CSV,data".parse_csv`