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

@see declarations are not getting their way into the manual #772

Closed
pirj opened this issue May 21, 2019 · 2 comments · Fixed by rubocop/rubocop#11317
Closed

@see declarations are not getting their way into the manual #772

pirj opened this issue May 21, 2019 · 2 comments · Fixed by rubocop/rubocop#11317

Comments

@pirj
Copy link
Member

pirj commented May 21, 2019

@see declarations in cop descriptions are quite common:

lib/rubocop/cop/rspec/subject_stub.rb|8| 10:      # @see https://robots.thoughtbot.com/don-t-stub-the-system-under-test
lib/rubocop/cop/rspec/leaky_constant_declaration.rb|20| 10:      # @see https://relishapp.com/rspec/rspec-mocks/docs/mutating-constants
lib/rubocop/cop/rspec/context_wording.rb|8| 10:      # @see https://github.com/reachlocal/rspec-style-guide#context-descriptions
lib/rubocop/cop/rspec/context_wording.rb|9| 10:      # @see http://www.betterspecs.org/#contexts
lib/rubocop/cop/rspec/example_wording.rb|10| 10:      # @see http://betterspecs.org/#should
lib/rubocop/cop/rspec/verified_doubles.rb|8| 10:      # @see https://relishapp.com/rspec/rspec-mocks/docs/verifying-doubles
lib/rubocop/cop/rspec/describe_symbol.rb|19| 10:      # @see https://github.com/rspec/rspec-core/issues/1610
lib/rubocop/cop/rspec/multiple_expectations.rb|8| 10:      # @see http://betterspecs.org/#single Single expectation test

Unfortunately, generate_cops_documentation rake task doesn't add them to manual/*.md files.

Find a way to add them.
Possible options:

  • fix cop documentation to use plain "See: "
  • fix documentation generator to include see to the manual. Keep in mind that @see may appear inside @example, though it's not yet the case in the current codebase.
@ydah
Copy link
Member

ydah commented Dec 22, 2022

@pirj @see is now output to the documentation as a Reference, so check back at the next RuboCop release!

@pirj
Copy link
Member Author

pirj commented Dec 22, 2022

Fantastic, thank you, @ydah !

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 a pull request may close this issue.

2 participants