From 6a6efedf2c712c672bc24ad1120cceac7b76d18c Mon Sep 17 00:00:00 2001 From: Petrik Date: Thu, 18 Jan 2024 10:48:27 +0100 Subject: [PATCH] Improve documentation of include directive file search 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. --- doc/rdoc/markup_reference.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/rdoc/markup_reference.rb b/doc/rdoc/markup_reference.rb index 17da68bb1d..bfc84abd5a 100644 --- 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 --include 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 --include +# command-line option. # # For C code, the directive may appear in a stand-alone comment #