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

Add docs on configuring RSpec aliases from gems #1097

Merged

Conversation

pirj
Copy link
Member

@pirj pirj commented Nov 18, 2020

Better viewed as https://github.com/rubocop-hq/rubocop-rspec/blob/add-doc-how-to-configure-rspec-aliases-in-third-party-gem/docs/modules/ROOT/pages/third_party_rspec_syntax_extensions.adoc

fixes #1077


Before submitting the PR make sure the following are checked:

  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • [-] Added tests.
  • Updated documentation.
  • [-] Added an entry to the CHANGELOG.md if the new code introduces user-observable changes.
  • The build (bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).

@pirj pirj self-assigned this Nov 18, 2020
@pirj pirj requested review from bquorning and Darhazer November 18, 2020 17:28
@pirj pirj force-pushed the add-doc-how-to-configure-rspec-aliases-in-third-party-gem branch 5 times, most recently from 243ed13 to f0f363d Compare November 18, 2020 17:34
Copy link
Member

@Darhazer Darhazer left a comment

Choose a reason for hiding this comment

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

Thank you 🙇

Copy link
Collaborator

@bquorning bquorning left a comment

Choose a reason for hiding this comment

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

I think we pretty consistently use either lowercase rubocop-rspec with a dash, or titlecase RuboCop RSpec with a space.

@pirj pirj force-pushed the add-doc-how-to-configure-rspec-aliases-in-third-party-gem branch from 5737495 to 22f8099 Compare November 19, 2020 14:16
@pirj
Copy link
Member Author

pirj commented Nov 19, 2020

I think we pretty consistently use either lowercase rubocop-rspec with a dash, or titlecase RuboCop RSpec with a space.

Indeed.
I've added a commit to remove remaining mentions of "RuboCop-RSpec" with a dash. I've copied one of it over which is a perfect example of how errors proliferate.

@pirj pirj merged commit 5e5eeba into master Nov 19, 2020
@pirj pirj deleted the add-doc-how-to-configure-rspec-aliases-in-third-party-gem branch November 19, 2020 14:21
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.

Add docs and provide a reference implementation on RSpec DSL aliases configuration in third-party gems
3 participants