From 5374c111fac4bbedc7bba2e7c2b0897436494457 Mon Sep 17 00:00:00 2001 From: Jared Beck Date: Tue, 27 Mar 2018 18:43:28 -0400 Subject: [PATCH] Linter config comments --- .rubocop.yml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 791db537..6b46e71f 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -58,7 +58,7 @@ Metrics/ClassLength: # The Ruby Style Guide recommends to "Limit lines to 80 characters." # (https://github.com/bbatsov/ruby-style-guide#80-character-limits) -# but 100 is also reasonable. +# Please aim for 80, but up to 100 is OK. Metrics/LineLength: Max: 100 @@ -76,9 +76,13 @@ Naming/FileName: Exclude: - Appraisals -# It is a decades-old convention to use EOS as a heredoc delimiter. There is -# not enough value in changinge this convention. SQL should still be used as -# a delimiter when appropriate. +# Heredocs are usually assigned to a variable or constant, which already has a +# name, so naming the heredoc doesn't add much value. Feel free to name +# heredocs that are used as anonymous values (not a variable, constant, or +# named parameter). +# +# All heredocs containing SQL should be named SQL, to support editor syntax +# highlighting. Naming/HeredocDelimiterNaming: Enabled: false