Skip to content

Commit

Permalink
[DOC] Improve documentation of include directive file search
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
p8 committed Mar 9, 2024
1 parent e4a67cf commit aa2d98e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/rdoc/markup_reference.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
#
Expand Down

0 comments on commit aa2d98e

Please sign in to comment.