Make Layout/LeadingCommentSpace aware of #:nodoc
#9964
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 PR makes `Layout/LeadingCommentSpace` aware of `#:nodoc`. The following mention is the trigger. https://twitter.com/kamipo/status/1421031611588485121 It seems that there was no definitive comment on whether to allow `#:nodoc:`. - rubocop#277 - rubocop@db79146 I've look RDoc doc's example of Ruby 3.0 and it looks to include leading comment space. ```ruby module MyModule # :nodoc: class Input end end module OtherModule # :nodoc: all class Output end end ``` https://docs.ruby-lang.org/en/3.0.0/RDoc/Markup.html#class-RDoc::Markup-label-Controlling+what+is+documented I also considered making it an option for the presence or absence of leading comment space in `#:nodoc:`, but I think it would be better to consistent it that space is included when possible as the role of cop.
|
I like the change, even if we'll likely get some complaints for it. Thanks! |
kamipo
added a commit
to rails/rails
that referenced
this pull request
Aug 12, 2021
Follow up to 18707ab, b87d8e5. rubocop 1.19.0 includes rubocop/rubocop#9964.
yahonda
added a commit
to yahonda/oracle-enhanced
that referenced
this pull request
Aug 13, 2021
Refer rubocop/rubocop#9964 ``` % bundle exec rubocop -a Inspecting 70 files .....CCC.CC..C.CC.CC.CCCCC.C.......................................... Offenses: lib/active_record/connection_adapters/emulation/oracle_adapter.rb:3:113: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. class ActiveRecord::ConnectionAdapters::OracleAdapter < ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/column.rb:4:29: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module ConnectionAdapters #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/column.rb:9:91: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def initialize(name, default, sql_type_metadata = nil, null = true, comment: nil) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/connection.rb:7:24: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. class Connection #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/connection.rb:121:49: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. class ConnectionException < StandardError #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/database_limits.rb:12:32: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def table_alias_length #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb:167:34: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def begin_db_transaction #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb:186:35: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def commit_db_transaction #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb:192:42: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def exec_rollback_db_transaction #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb:198:61: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def create_savepoint(name = current_savepoint_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb:202:71: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def exec_rollback_to_savepoint(name = current_savepoint_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb:206:62: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def release_savepoint(name = current_savepoint_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb:217:49: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def insert_fixture(fixture, table_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb:252:64: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def write_lobs(table_name, klass, attributes, columns) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/jdbc_connection.rb:55:57: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. class JDBCConnection < OracleEnhanced::Connection #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/lob.rb:3:21: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module ActiveRecord #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/lob.rb:4:29: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module ConnectionAdapters #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/lob.rb:5:27: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module OracleEnhanced #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/lob.rb:6:18: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module Lob #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:29:56: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. class OCIConnection < OracleEnhanced::Connection #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:302:38: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. class OracleEnhancedOCIFactory #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:378:1: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. ^^^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:379:53: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. class OCI8EnhancedAutoRecover < DelegateClass(OCI8) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:380:25: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. attr_accessor :active #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:381:26: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. alias :active? :active #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:385:36: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. alias :auto_retry? :auto_retry #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:389:35: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def initialize(config, factory) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:400:12: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def ping #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:409:14: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def reset! #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:426:64: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. LOST_CONNECTION_ERROR_CODES = [ 28, 1012, 3113, 3114, 3135 ] #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:429:18: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def with_retry #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:444:36: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def exec(sql, *bindvars, &block) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/oci_connection.rb:448:1: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. ^^^^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/procedures.rb:5:21: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module ActiveRecord #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/procedures.rb:36:35: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module OracleEnhancedProcedures #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/procedures.rb:86:17: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def destroy #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/quoting.rb:11:37: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def quote_column_name(name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/quoting.rb:23:51: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def quote_column_name_or_expression(name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/quoting.rb:58:42: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def self.valid_table_name?(name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/quoting.rb:68:36: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def quote_table_name(name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/quoting.rb:73:29: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def quote_string(s) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/quoting.rb:77:27: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def _quote(value) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/quoting.rb:94:25: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def quoted_true #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/quoting.rb:99:27: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def unquoted_true #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/quoting.rb:104:26: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def quoted_false #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/quoting.rb:109:28: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def unquoted_false #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_definitions.rb:38:78: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. class SynonymDefinition < Struct.new(:name, :table_owner, :table_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_dumper.rb:3:21: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module ActiveRecord #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_dumper.rb:4:29: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module ConnectionAdapters #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_dumper.rb:5:27: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module OracleEnhanced #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_dumper.rb:6:61: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. class SchemaDumper < ConnectionAdapters::SchemaDumper #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:13:20: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def tables #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:69:32: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def materialized_views #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:89:33: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def indexes(table_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:255:48: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def rename_table(table_name, new_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:267:47: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def drop_table(table_name, **options) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:298:59: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def add_index(table_name, column_name, **options) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:308:81: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def add_index_options(table_name, column_name, comment: nil, **options) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:332:68: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def remove_index(table_name, column_name = nil, **options) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:340:45: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def index_name(table_name, options) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:380:58: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def rename_index(table_name, old_name, new_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:415:66: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def add_column(table_name, column_name, type, **options) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:432:80: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def change_column_default(table_name, column_name, default_or_changes) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:439:78: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def change_column_null(table_name, column_name, null, default = nil) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:449:69: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def change_column(table_name, column_name, type, **options) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:473:69: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def rename_column(table_name, column_name, new_column_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:480:78: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def remove_column(table_name, column_name, type = nil, options = {}) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:510:39: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def table_comment(table_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:526:53: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def column_comment(table_name, column_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:538:75: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def type_to_sql(type, limit: nil, precision: nil, scale: nil, **) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:555:38: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def foreign_keys(table_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/schema_statements.rb:599:51: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def disable_referential_integrity(&block) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:3:21: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module ActiveRecord #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:4:29: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module ConnectionAdapters #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:5:27: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module OracleEnhanced #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:6:28: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module StructureDump #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:10:28: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def structure_dump #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:63:43: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def structure_dump_column(column) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:78:65: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def structure_dump_virtual_column(column, data_default) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:92:47: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def structure_dump_primary_key(table) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:111:47: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def structure_dump_unique_keys(table) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:132:48: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def structure_dump_indexes(table_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:148:43: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def structure_dump_fk_constraints #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:193:60: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def foreign_key_definition(to_table, options = {}) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:210:43: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def structure_dump_db_stored_code #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:242:34: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def structure_dump_views #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:254:37: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def structure_dump_synonyms #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:268:28: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def structure_drop #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:291:29: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def temp_table_drop #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/structure_dump.rb:303:48: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def full_drop(preserve_tables = false) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced/type_metadata.rb:4:29: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module ConnectionAdapters #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:66:29: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module ConnectionHandling #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:68:44: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def oracle_enhanced_connection(config) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:82:29: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. module ConnectionAdapters #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:252:24: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def adapter_name #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:276:32: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def supports_savepoints? #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:280:43: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def supports_transaction_isolation? #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:363:7: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. #:stopdoc: ^^^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:382:7: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. #:stopdoc: ^^^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:388:7: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. #:stopdoc: ^^^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:412:7: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. #:startdoc: ^^^^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:414:33: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def native_database_types #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:424:31: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. attr_reader :auto_retry #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:427:30: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def auto_retry=(value) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:438:19: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def active? #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:449:22: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def reconnect! #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:462:23: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def disconnect! #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:500:82: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def reset_pk_sequence!(table_name, primary_key = nil, sequence_name = nil) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:594:79: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def pk_and_sequence_for(table_name, owner = nil, desc_table_name = nil) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:632:76: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def has_primary_key?(table_name, owner = nil, desc_table_name = nil) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:652:49: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def columns_for_distinct(columns, orders) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:668:40: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def temporary_table?(table_name) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:734:37: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def extract_limit(sql_type) #:nodoc: ^^^^^^^^ lib/active_record/connection_adapters/oracle_enhanced_adapter.rb:743:68: C: [Corrected] Layout/LeadingCommentSpace: Missing space after #. def translate_exception(exception, message:, sql:, binds:) #:nodoc: ^^^^^^^^ 70 files inspected, 114 offenses detected, 114 offenses corrected yahonda@mymacbookpro oracle-enhanced %
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 PR makes
Layout/LeadingCommentSpaceaware of#:nodoc.The following mention is the trigger.
https://twitter.com/kamipo/status/1421031611588485121
It seems that there was no definitive comment on whether to allow
#:nodoc:.I've look RDoc doc's example of Ruby 3.0 and it looks to include leading comment space.
https://docs.ruby-lang.org/en/3.0.0/RDoc/Markup.html#class-RDoc::Markup-label-Controlling+what+is+documented
I also considered making it an option for the presence or absence of leading comment space in
#:nodoc:, but I think it would be better to consistent it that space is included when possible as the role of cop.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.