Address yard issues #1379
Merged
Address yard issues #1379
Conversation
This file contains hidden or 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 fixes the error generated by the script when attempting to check documentation coverage: > /.gem/ruby/2.2.2/gems/bundler-1.9.4/lib/bundler/rubygems_integration.rb:316:in `block in replace_bin_path': can't find executable yard (Gem::Exception) > from bin/yard:16:in `<main>'
Both of these are meant to be private APIs. They were not marked as such before because the `bin/yard` command was failing previously.
> [warn]: in YARD::Handlers::Ruby::MethodHandler: Undocumentable method defined on object instance > [warn]: in file 'lib/rspec/rails/configuration.rb':73: > > 73: def config.render_views=(val) > > [warn]: in YARD::Handlers::Ruby::MethodHandler: Undocumentable method defined on object instance > [warn]: in file 'lib/rspec/rails/configuration.rb':77: > > 77: def config.render_views > > [warn]: in YARD::Handlers::Ruby::MethodHandler: Undocumentable method defined on object instance > [warn]: in file 'lib/rspec/rails/configuration.rb':81: > > 81: def config.render_views? > > [warn]: in YARD::Handlers::Ruby::MethodHandler: Undocumentable method defined on object instance > [warn]: in file 'lib/rspec/rails/configuration.rb':85: > > 85: def config.infer_spec_type_from_file_location! > > [warn]: Syntax error in `lib/generators/rspec/mailer/templates/preview.rb`:(1,1): syntax error, unexpected '<' > [warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class RSpec::Rails::RoutingExampleGroup > [warn]: in file 'lib/rspec/rails/example/routing_example_group.rb':11: > > 11: include RSpec::Rails::AssertionDelegator.new(ActionDispatch::Assertions::RoutingAssertions) > > [warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class RSpec::Rails::ControllerExampleGroup > [warn]: in file 'lib/rspec/rails/example/controller_example_group.rb':12: > > 12: include RSpec::Rails::AssertionDelegator.new(ActionDispatch::Assertions::RoutingAssertions) > > [warn]: Syntax error in `lib/generators/rspec/install/templates/spec/rails_helper.rb`:(23,1): syntax error, unexpected '<', expecting end-of-input
This addresses doc coverage issues with the most recent release of YARD.
| def config.render_views=(val) | ||
| self.rendering_views = val | ||
| end | ||
| config.instance_exec do |
There was a problem hiding this comment.
Is instance_exec really necessary to fix up the yard?
There was a problem hiding this comment.
YARD issues warnings about writing the methods directly on the object:
[warn]: in YARD::Handlers::Ruby::MethodHandler: Undocumentable method defined on object instance
[warn]: in file 'lib/rspec/rails/configuration.rb':73:73: def config.render_views=(val)
Using instance_exec provides access to the same singleton scope allowing us to write the methods. Another option would be place all of those methods into a module and then access the singleton class directly (providing proper 1.8.7 backwards compat) to include the aforementioned module.
|
LGTM |
This fixes the access to the controller attribute, making it clear that the setter should be a `private` internal API. This was reflected previously in the YARD doc, but that did not match the code.
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 makes YARD available in the dev/test environment again, fixing the
bin/yardfailure. It also updates the docs to get minimal 100% coverage and addresses the outstanding warnings.Fix #1297