-
Notifications
You must be signed in to change notification settings - Fork 439
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Deprecate main
and title
directives
#1218
Conversation
ead41d2
to
c197c94
Compare
I tried to do a quick test to see how the Does the |
Yes it's the same as the |
1e03e16
to
83a3561
Compare
It seems (please correct me if I'm wrong) that this directive allows you to customise the title for each document generated from RDoc, which could be pretty useful for SEO. I remember that we just merged something recently that now lets us customise keyboards and meta descriptions. Would the |
Before #1091, Even after #1091 started using it for SEO tags, the For SEO customization in the future, I think adding new |
(ruby/rdoc#1218) * Deprecate :main: directive * Deprecate :title: direcive * Update documentation * Remove :main: directive's usage * Update test cases * Add '.rdoc_options' to suggested alternatives ruby/rdoc@e2d4ac9dad
Both main page and default title of a documentation should be global and immutable settings for the target project. Allowing users to override them in the middle of the documentation makes RDoc error-prone (see #426) and doesn't encourage the right behaviour.
We should deprecate these directives and remove them in the 7.0 release.