Skip to content

Commit 83a3561

Browse files
committed
Add '.rdoc_options' to suggested alternatives
1 parent de3ced4 commit 83a3561

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

lib/rdoc/markup/pre_process.rb

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,10 @@ def handle_directive prefix, directive, param, code_object = nil,
190190
warn <<~MSG
191191
The :main: directive is deprecated and will be removed in RDoc 7.
192192
193-
Use `--main=#{param}` to specify the initial page displayed.
194-
If you use `RDoc::Task`, use `rdoc.main = "#{param}"` instead.
193+
You can use these options to specify the initial page displayed instead:
194+
- `--main=#{param}` via the command line
195+
- `rdoc.main = "#{param}"` if you use `RDoc::Task`
196+
- `main_page: #{param}` in your `.rdoc_options` file
195197
MSG
196198

197199
blankline
@@ -226,8 +228,10 @@ def handle_directive prefix, directive, param, code_object = nil,
226228
warn <<~MSG
227229
The :title: directive is deprecated and will be removed in RDoc 7.
228230
229-
Use `--title=#{param}` to specify the title displayed.
230-
If you use `RDoc::Task`, use `rdoc.title = "#{param}"` instead.
231+
You can use these options to specify the title displayed instead:
232+
- `--title=#{param}` via the command line
233+
- `rdoc.title = "#{param}"` if you use `RDoc::Task`
234+
- `title: #{param}` in your `.rdoc_options` file
231235
MSG
232236

233237
blankline

lib/rdoc/parser/c.rb

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1108,8 +1108,10 @@ def look_for_directives_in context, comment
11081108
warn <<~MSG
11091109
The :main: directive is deprecated and will be removed in RDoc 7.
11101110
1111-
Use `--main=#{param}` to specify the initial page displayed.
1112-
If you use `RDoc::Task`, use `rdoc.main = "#{param}"` instead.
1111+
You can use these options to specify the initial page displayed instead:
1112+
- `--main=#{param}` via the command line
1113+
- `rdoc.main = "#{param}"` if you use `RDoc::Task`
1114+
- `main_page: #{param}` in your `.rdoc_options` file
11131115
MSG
11141116
''
11151117
when 'title' then
@@ -1118,8 +1120,10 @@ def look_for_directives_in context, comment
11181120
warn <<~MSG
11191121
The :title: directive is deprecated and will be removed in RDoc 7.
11201122
1121-
Use `--title=#{param}` to specify the title displayed.
1122-
If you use `RDoc::Task`, use `rdoc.title = "#{param}"` instead.
1123+
You can use these options to specify the title displayed instead:
1124+
- `--title=#{param}` via the command line
1125+
- `rdoc.title = "#{param}"` if you use `RDoc::Task`
1126+
- `title: #{param}` in your `.rdoc_options` file
11231127
MSG
11241128
''
11251129
end

0 commit comments

Comments
 (0)