Fix docs for Style/SpecialGlobalVars use_builtin_english_names
#12887
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I don't think this was good, I didn't get a notification for the CI failure. It should have been prefixed with |
koic
added a commit
that referenced
this pull request
May 6, 2024
Follow up #12887. This commit fixes the following build error: ```console $ bundle exec rake documentation_syntax_check (snip) lib/rubocop/cop/style/special_global_vars.rb: Syntax Error in an example. unexpected token tIDENTIFIER ``` https://app.circleci.com/pipelines/github/rubocop/rubocop/11118/workflows/dfa24f2b-a0f5-405b-86a6-cbf87cb3caac/jobs/311295
|
I've fixed it in the master branch. |
|
Thank you |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The code block is currently empty and moved to the top (above the safety section), I assume because of the bad indentation. https://docs.rubocop.org/rubocop/cops_style.html#enforcedstyle-use_builtin_english_names
I didn't figure out how to build the docs locally. So this is a speculative fix on my part.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.