Skip to content

Commit 7b4f85a

Browse files
committed
[DOC] RDoc Sources
1 parent f1d653e commit 7b4f85a

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

.document

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
*.md
22
*.rdoc
33
lib
4-
doc
4+
doc/rdoc/*
5+

doc/rdoc/rdoc_sources.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
\RDoc derives Ruby documentation from files
44
that are selected by \RDoc defaults and by user specifications.
55

6-
\RDoc reads files and directories specified as arguments on the `rdoc` command line
7-
(`'.'` if no arguments given).
6+
\RDoc reads files and directories specified as arguments on the `rdoc` command line;
7+
if no arguments are given, reads files and directories starting in `'.'`
8+
the current working directory.
89

9-
When the argument is:
10+
When anq argument is:
1011

1112
- A file path: \RDoc reads the file.
1213
- A directory path:
@@ -19,7 +20,7 @@ When the argument is:
1920
Based on the file extension of a file name,
2021
\RDoc assumes its content to be one of these:
2122

22-
- `.rb`: Ruby code.
23+
- `.rb`, `.rbw`: Ruby code.
2324
- `.c`, `.h`, `.C`, `.H`: C code.
2425
- `.rdoc`: Text file in `rdoc` (markup) format.
2526
- `.md`: Text file in `markdown` format.
@@ -68,7 +69,7 @@ Each directory in the filetree may (or may not) contain a document-control file.
6869
Note that a document-control file in a subdirectory is read _after_ document-control files
6970
in directories above it;
7071
therefore if file `parent/.document` specifies `child/foo.rb`,
71-
then `child/foo.rb` is to be read regardless of the content of `child/.document`.
72+
then `child/foo.rb` is read regardless of the content of `child/.document`.
7273

7374
[document-control files]: rdoc-ref:rdoc_sources.md@Document-Control+Files
7475
[directive markup]: https://ruby.github.io/rdoc/RDoc/MarkupReference.html#class-RDoc::MarkupReference-label-3Amarkup-3A

0 commit comments

Comments
 (0)