Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Align behaviour between bundle exec rdoc and rake rdoc #1156

Merged
merged 2 commits into from
Aug 22, 2024
Merged

Align behaviour between bundle exec rdoc and rake rdoc #1156

merged 2 commits into from
Aug 22, 2024

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Aug 19, 2024

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.

Closes #1123

olleolleolle
olleolleolle reviewed Aug 20, 2024
View reviewed changes
Copy link
Contributor

@olleolleolle olleolleolle left a 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?

Rakefile Outdated Show resolved Hide resolved
@olleolleolle olleolleolle mentioned this pull request Aug 20, 2024
Closed
@st0012
Align behaviour between bundle exec rdoc and rake rdoc
e60ea35 
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.
olleolleolle
olleolleolle reviewed Aug 21, 2024
View reviewed changes
Copy link
Contributor

@olleolleolle olleolleolle left a 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.

.rdoc_options Outdated Show resolved Hide resolved
Rakefile Outdated Show resolved Hide resolved
@st0012 @olleolleolle
Apply suggestions from code review
c5bff87 
Co-authored-by: Olle Jonsson <olle.jonsson@gmail.com>
olleolleolle
olleolleolle approved these changes Aug 21, 2024
View reviewed changes
Copy link
Contributor

@olleolleolle olleolleolle left a 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!

@st0012 st0012 merged commit 5749b22 into master Aug 22, 2024
51 checks passed
@st0012 st0012 deleted the fix-#1123 branch August 22, 2024 15:35
@p8
Copy link
Contributor

p8 commented Aug 27, 2024 •
edited
Loading

I'd love to see this getting merged so we can move the following to .rdoc_options in Rails:
https://github.com/rails/rails/blob/4bb2227640531c877e30cc96f10df0c298dc3331/railties/lib/rails/api/task.rb#L9-L117
If RDoc can generate documentation without having to install the dependencies (so just rdoc instead of bundle exec rdoc), we could run RDoc for older versions of gems/rails without having to install the gems unsupported/deprecated dependencies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@olleolleolle olleolleolle olleolleolle approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Proposal] bundle exec rdoc command should work for rdoc itself
3 participants
@st0012 @p8 @olleolleolle