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

Update Ruby docs with latest Rails support #35

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

modulitos
Copy link

@modulitos modulitos commented Oct 23, 2022

This PR updates the Ruby docs to leverage the support Rails has recently provided for SQLCommenter. This will facilitate adoption of SQLCommenter for folks who aren't familiar with how SQLCommenter support has changed across Rails versions.

Note that the current docs are not compatible with Rails versions 6.0 and up. This PR makes the following changes to bring them up to date:

  1. For Rails >=7.1, include docs about how SQLCommenter is now fully supported as the default formatter
    • Support was added in this PR, and it will be the default formatter as well (added in this PR).
  2. For Rails 7.0, include docs on the PlanetScale SQLCommenter gem which is a workaround that provides SQLCommenter support for Rails 7.0
    • The Marginalia library was re-implemented natively in Rails version 7.0 (in this PR), so the current documentation that leverages a Marginalia fork will not work.
  3. Replace glebm's fork of Marginalia with modulitos's fork, which includes updates to support Rails 6.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Oct 23, 2022

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: modulitos / name: Lucas Swart (e61efa8)

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

Successfully merging this pull request may close these issues.

1 participant