diff options
| author | Petrik de Heus <petrik@deheus.net> | 2024-03-09 06:46:45 +0100 |
|---|---|---|
| committer | git <svn-admin@ruby-lang.org> | 2024-03-09 05:46:49 +0000 |
| commit | a69910211b161487b6d240e9d068aa19644214db (patch) | |
| tree | 2a1a47855b3a8ded90ef3d074f9e8a5b9597353c /doc | |
| parent | 5ac6194c2b13856edd7e7bcaaa69a15519fd993e (diff) | |
[ruby/rdoc] [DOC] 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.
https://github.com/ruby/rdoc/commit/aa2d98ee5e
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rdoc/markup_reference.rb | 6 |
1 files 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 @@ require 'rdoc' # 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 # |