Workaround for Ruby's warning in YARD #12999
Merged
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
This is a workaround to prevent the following warning in YARD: ```console $ ruby -v ruby 3.4.0dev (2024-06-14T03:14:32Z master 2677ab1607) [x86_64-darwin23] $ cd path/to/rubocop $ bundle exec rake /Users/koic/.rbenv/versions/3.4-dev/lib/ruby/gems/3.4.0+0/gems/yard-0.9.36/lib/yard/logging.rb:3: warning: logger was loaded from the standard library, but will no longer be part of the default gems since Ruby 3.5.0. Add logger to your Gemfile or gemspec. ``` The fundamental resolution will likely be addressed in lsegal/yard#1546.
koic
force-pushed
the
add_logger_to_gemfile
branch
from
ca9d5ef
to
0b22131
Compare
koic
added a commit
to koic/rubocop
that referenced
this pull request
Jun 17, 2024
This is a workaround to prevent the following error in 3.4.0dev CI matrix:
```console
==> Failures
1) RuboCop::CLI profiling creates memory profile file
Got 3 failures from failure aggregation block.
(snip)
*.1) Failure/Error: expect(cli.run(['--profile', '--memory', 'example1.rb'])).to eq(0)
expected: 0
got: 2
(compared using ==)
# ./spec/rubocop/cli_spec.rb:2200:in 'block (3 levels) in <top (required)>'
*.2) Failure/Error: expect($stdout.string.include?('Building memory report...')).to be(true)
expected true
got false
# ./spec/rubocop/cli_spec.rb:2201:in 'block (3 levels) in <top (required)>'
*.3) Failure/Error: expect(File).to exist(memory_profile)
expected File to exist
# ./spec/rubocop/cli_spec.rb:2202:in 'block (3 levels) in <top (required)>'
```
https://github.com/rubocop/rubocop/actions/runs/9542192514/job/26296594698
It is necessary to investigate and resolve the error that occurred with Ruby 3.4-dev in rubocop#12999 separately.
8 tasks
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.
This is a workaround to prevent the following warning in YARD:
The fundamental resolution will likely be addressed in lsegal/yard#1546.
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.