From d711a2c9d3603c4acb1a2e73d3fb4deb7e11773a Mon Sep 17 00:00:00 2001 From: OKURA Masafumi Date: Mon, 12 Aug 2024 22:21:04 +0800 Subject: [PATCH] [doc] Mention `.document` file in README (#1153) * 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,