Skip to content

Make spelling of Action Cable consistent in docs

John Hope requested to merge jh-consistent-ac-spelling into master

What does this MR do?

Correct spelling of Action Cable includes a space between the words, consistent with other Rails projects (Active Record, Action Mailer)

It's sometimes confusing because the classnames remove the space; e.g. ActiveRecord::Base. Doubly so because it breaks the Ruby convention of replacing the space with an underscore in the filename; activerecord/ instead of active_record/. But this is a well established quirk of Rails.

This MR updates the Action Cable documentation, which currently uses both spellings interchangeably, to just use the correct one.

Related issues

Author's checklist (required)

Do not add the ~"feature", frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports