From 2fce17cf485b779b483d9e12f0a1e817adc178fb Mon Sep 17 00:00:00 2001 From: OKURA Masafumi Date: Sat, 10 Aug 2024 20:43:58 +0900 Subject: [PATCH 1/3] Mention `.document` file in README Rdoc has `.document` file in its root directory, allowing us to determine which files are the target for documentation. However, this fact is not mentioned anywhere in the doc including README, which makes it quite difficult to utilize this feature. This commit adds a mention to `.document` file in README so that users can find the feature more easily. One thing I'm not sure is if it's the right place. Currently README includes some usage information, which can be a separate file. --- README.rdoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rdoc b/README.rdoc index fd5bba4fdf..5a698edc88 100644 --- a/README.rdoc +++ b/README.rdoc @@ -60,6 +60,10 @@ To generate documentation programmatically: rdoc.document options # see RDoc::RDoc +You can specify the target files for document generation with +.document+ file in the project root directory. ++.document+ file contains a list of file and directory names including comment lines starting with '#'. +See https://github.com/ruby/rdoc/blob/master/.document as an example. + == Writing Documentation To write documentation for RDoc place a comment above the class, module, From c2c15c66cd30c95b1e4a7ec2acf65945ca457b87 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Mon, 12 Aug 2024 15:05:57 +0100 Subject: [PATCH 2/3] Update README.rdoc --- README.rdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rdoc b/README.rdoc index 5a698edc88..2400119bba 100644 --- a/README.rdoc +++ b/README.rdoc @@ -61,7 +61,7 @@ To generate documentation programmatically: # see RDoc::RDoc You can specify the target files for document generation with +.document+ file in the project root directory. -+.document+ file contains a list of file and directory names including comment lines starting with '#'. ++.document+ file contains a list of file and directory names including comment lines starting with +#+. See https://github.com/ruby/rdoc/blob/master/.document as an example. == Writing Documentation From 934c04b534a5f4f64772960c71c7b2e0ee8d6a7a Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Mon, 12 Aug 2024 15:07:22 +0100 Subject: [PATCH 3/3] Update README.rdoc --- README.rdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rdoc b/README.rdoc index 2400119bba..5a698edc88 100644 --- a/README.rdoc +++ b/README.rdoc @@ -61,7 +61,7 @@ To generate documentation programmatically: # see RDoc::RDoc You can specify the target files for document generation with +.document+ file in the project root directory. -+.document+ file contains a list of file and directory names including comment lines starting with +#+. ++.document+ file contains a list of file and directory names including comment lines starting with '#'. See https://github.com/ruby/rdoc/blob/master/.document as an example. == Writing Documentation