Document support for frozen_string_literal: false

[gfyoung]

xref #7426

[gfyoung]

[1 / 2]

This is my first time contributing to the rubocop project, so I'm not 100% sure about commit messages. My PR is not "fixing" the issue (it's a two-parter, and this only addresses one part of it), so I wasn't sure that I needed to add a "fix" prefix to my commit message (FYI: my current commit summary barely makes the cutoff at 49 characters).

Let me know what makes sense here!

[2 / 2]

As I was writing this up, two questions:

• Does it make sense to include an example showing frozen_string_literal: false ?
• Should the error message from rubocop be updated to indicate we also support false (my fear is that people might be scared that they have to add true because rubocop said so) ?

[Drenmi]

🙏

[bbatsov]

The comment seems a bit confusing to me. Shouldn't it say that RuboCop will ignore files where the the comment exists and is set to false instead?

[gfyoung]

The comment seems a bit confusing to me. Shouldn't it say that RuboCop will ignore files where the the comment exists and is set to false instead?

@bbatsov : We can write it like that as well. I just want to make it clear that users have an alternative if they have the cop turned on (the error message from the cop does not indicate that)

[gfyoung]

@bbatsov : I've updated the wording and included an example. Have a look.

[bbatsov]

Looks good to me. Thanks!