-
Notifications
You must be signed in to change notification settings - Fork 441
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
Align behaviour between bundle exec rdoc
and rake rdoc
#1156
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about keeping the contextual knowledge that _site is chosen for GitHub Pages?
By using `.rdoc_options` to specify the RDoc options, we can make most of the rake task options the in-repo defaults. This allows us to use the same options for both `bundle exec rdoc` and `rake rdoc` and get a consistent experience.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I liked that the comments follow into the configuration file. I added tiny changes, minor.
Co-authored-by: Olle Jonsson <olle.jonsson@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this is super!
I recommend this be merged!
I'd love to see this getting merged so we can move the following to .rdoc_options in Rails: |
- lib/rdoc/rd/inline_parser.ry | ||
- lib/rdoc/markdown.kpeg | ||
- lib/rdoc/markdown/literals.kpeg | ||
op_dir: _site # for GitHub Pages and should match the config of RDoc task in Rakefile |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--op-dir
option is not saved by --write-options
.
Is this expected?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it is. But the bigger problem is that the presence of options (and some of their names) are different across Rake task, command line, and .rdoc_options
. I think we should do a review and consolidation on them next year.
By using
.rdoc_options
to specify the RDoc options, we can make most of the rake task options the in-repo defaults.This allows us to use the same options for both
bundle exec rdoc
andrake rdoc
and get a consistent experience.Closes #1123