diff options
| author | Stan Lo <[email protected]> | 2024-12-05 19:36:28 +0800 |
|---|---|---|
| committer | git <[email protected]> | 2024-12-05 11:36:34 +0000 |
| commit | 2ecd2fe0ed251f9946d5322d96cbfaf61ccbdd65 (patch) | |
| tree | 031e8efe7795cb645b95abd2dc6730733c07c8c0 /lib/rdoc/markup | |
| parent | 866f1a1f2d6f0425b1535fb5697a30404e83e7c2 (diff) | |
[ruby/rdoc] Deprecate `main` and `title` directives
(https://github.com/ruby/rdoc/pull/1218)
* Deprecate :main: directive
* Deprecate :title: direcive
* Update documentation
* Remove :main: directive's usage
* Update test cases
* Add '.rdoc_options' to suggested alternatives
https://github.com/ruby/rdoc/commit/e2d4ac9dad
Diffstat (limited to 'lib/rdoc/markup')
| -rw-r--r-- | lib/rdoc/markup/pre_process.rb | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/rdoc/markup/pre_process.rb b/lib/rdoc/markup/pre_process.rb index 979f2eadae..3270f8ada2 100644 --- a/lib/rdoc/markup/pre_process.rb +++ b/lib/rdoc/markup/pre_process.rb @@ -187,6 +187,14 @@ class RDoc::Markup::PreProcess include_file filename, prefix, encoding when 'main' then @options.main_page = param if @options.respond_to? :main_page + warn <<~MSG + The :main: directive is deprecated and will be removed in RDoc 7. + + You can use these options to specify the initial page displayed instead: + - `--main=#{param}` via the command line + - `rdoc.main = "#{param}"` if you use `RDoc::Task` + - `main_page: #{param}` in your `.rdoc_options` file + MSG blankline when 'nodoc' then @@ -217,6 +225,15 @@ class RDoc::Markup::PreProcess when 'title' then @options.default_title = param if @options.respond_to? :default_title= + warn <<~MSG + The :title: directive is deprecated and will be removed in RDoc 7. + + You can use these options to specify the title displayed instead: + - `--title=#{param}` via the command line + - `rdoc.title = "#{param}"` if you use `RDoc::Task` + - `title: #{param}` in your `.rdoc_options` file + MSG + blankline when 'yield', 'yields' then return blankline unless code_object |