Small RDoc changes for recipes (#190)

BurdetteLamar · web-flow · commit 2102c78384b9 · 2020-10-29T10:12:11.000+09:00
diff --git a/README.md b/README.md
@@ -31,6 +31,11 @@ CSV.foreach("path/to/file.csv") do |row|
 end
 ```
 
+## Documentation
+
+- {API}[CSV.html]:  all classes, methods, and constants.
+- {Recipes}[doc/csv/recipes/recipes_rdoc.html]:  specific code for specific tasks.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
diff --git a/doc/csv/recipes/filtering.rdoc b/doc/csv/recipes/filtering.rdoc
@@ -1,5 +1,7 @@
 == Recipes for Filtering \CSV
 
+These recipes are specific code examples for specific \CSV filtering tasks.
+
 For other recipes, see {Recipes for CSV}[./recipes_rdoc.html].
 
 All code snippets on this page assume that the following has been executed:
diff --git a/doc/csv/recipes/generating.rdoc b/doc/csv/recipes/generating.rdoc
@@ -1,5 +1,7 @@
 == Recipes for Generating \CSV
 
+These recipes are specific code examples for specific \CSV generating tasks.
+
 For other recipes, see {Recipes for CSV}[./recipes_rdoc.html].
 
 All code snippets on this page assume that the following has been executed:
diff --git a/doc/csv/recipes/parsing.rdoc b/doc/csv/recipes/parsing.rdoc
@@ -1,5 +1,7 @@
 == Recipes for Parsing \CSV
 
+These recipes are specific code examples for specific \CSV parsing tasks.
+
 For other recipes, see {Recipes for CSV}[./recipes_rdoc.html].
 
 All code snippets on this page assume that the following has been executed:
diff --git a/doc/csv/recipes/recipes.rdoc b/doc/csv/recipes/recipes.rdoc
@@ -1,6 +1,6 @@
 == Recipes for \CSV
 
-See:
+The recipes are specific code examples for specific tasks. See:
 - {Recipes for Parsing CSV}[./parsing_rdoc.html]
 - {Recipes for Generating CSV}[./generating_rdoc.html]
 - {Recipes for Filtering CSV}[./filtering_rdoc.html]
diff --git a/lib/csv.rb b/lib/csv.rb
@@ -111,6 +111,8 @@
 # you may want to go directly to the:
 # - {Recipes for CSV}[doc/csv/recipes/recipes_rdoc.html].
 #
+# Otherwise, read on here, about the API: classes, methods, and constants.
+#
 # === \CSV Data
 #
 # \CSV (comma-separated values) data is a text representation of a table:

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,8 @@`
`111`	`111`	`# you may want to go directly to the:`
`112`	`112`	`# - {Recipes for CSV}[doc/csv/recipes/recipes_rdoc.html].`
`113`	`113`	`#`
	`114`	`+# Otherwise, read on here, about the API: classes, methods, and constants.`
	`115`	`+#`
`114`	`116`	`# === \CSV Data`
`115`	`117`	`#`
`116`	`118`	`# \CSV (comma-separated values) data is a text representation of a table:`