[DOC] Improve documentation of include directive file search

p8 · web-flow · commit aa2d98ee5e57 · 2024-03-09T14:46:45.000+09:00
Searching the file in the "current directory" could be read as the
directory from which RDoc is run. This is incorrect, as the file is
first searched in the directory containing the current documented file.

Also this directory is searched before the `--include` directories.
diff --git a/doc/rdoc/markup_reference.rb b/doc/rdoc/markup_reference.rb
@@ -641,9 +641,9 @@
 #     The file content is shifted to have the same indentation as the colon
 #     at the start of the directive.
 #
-#     The file is searched for in the directories
-#     given with the <tt>--include</tt> command-line option,
-#     or by default in the current directory.
+#     The file is searched for in the directory containing the current file,
+#     and then in each of the directories given with the <tt>--include</tt>
+#     command-line option.
 #
 #   For C code, the directive may appear in a stand-alone comment
 #

Original file line number	Diff line number	Diff line change
`@@ -641,9 +641,9 @@`
`641`	`641`	`# The file content is shifted to have the same indentation as the colon`
`642`	`642`	`# at the start of the directive.`
`643`	`643`	`#`
`644`		`-# The file is searched for in the directories`
`645`		`-# given with the <tt>--include</tt> command-line option,`
`646`		`-# or by default in the current directory.`
	`644`	`+# The file is searched for in the directory containing the current file,`
	`645`	`+# and then in each of the directories given with the <tt>--include</tt>`
	`646`	`+# command-line option.`
`647`	`647`	`#`
`648`	`648`	`# For C code, the directive may appear in a stand-alone comment`
`649`	`649`	`#`