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.

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

Use explicit module for Rails::HealthController #47728

Merged
merged 1 commit into from
Mar 22, 2023

Conversation

p8
Copy link
Member

@p8 p8 commented Mar 21, 2023

This makes sure it falls under the "Rails" section of the API sidebar instead of its own section.

image

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

This makes sure it falls under the "Rails" section of the API sidebar.
@rails-bot rails-bot bot added the railties label Mar 21, 2023
Copy link
Member

@zzak zzak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO this is a bug in RDoc, there are a few places this can occur, and first noticed it when trying to deal with the Rails::Rails::Conductor mess.

But only this and RaiseWarnings actually show up at the top-level, I think they are worth fixing this way.

@guilleiguaran guilleiguaran merged commit fedaf03 into rails:main Mar 22, 2023
@p8 p8 deleted the docs/health-controller branch March 22, 2023 09:37
@p8
Copy link
Member Author

p8 commented Mar 22, 2023

But only this and RaiseWarnings actually show up at the top-level, I think they are worth fixing this way.

RaiseWarnings is a top level class though, so it makes sense to have it at the top level I guess.
Not sure if it could be namespaced under ActiveSupport::Testing instead.
cc @byroot

@byroot
Copy link
Member

byroot commented Mar 22, 2023

Yeah, good point. It should be nodoc, and we can move it under a namespaces, but the later doesn't matter as much because it's not shipped with the gem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants