[DOC] Improve documentation of :include:
directive file search
#1083
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current documentation is incorrect.
"The current directory" is searched before the
--include
directories.See:
rdoc/lib/rdoc/markup/pre_process.rb
Lines 288 to 296 in 4e14158
"Searching the file by default in the current directory" could be read as "searching the file in the directory from which RDoc is run". This is incorrect, as the file is first searched in the directory containing the current documented file.