Explain EnforceSigilOrder better in documentation

[marknuzz]

The first thing we often get when installing rubocop-sorbet is a mass amount of requests to change the sigil ordering in files. That's a big commit, and it might cause people to ask what the significance of the ordering means. But the documentation does not provide any of this.

[andyw8]

There is no technical significance to the ordering of magic comments.

If we changed the message to "Magic comments should be in the following order for consistency", would that help?

[marknuzz]

There is no technical significance to the ordering of magic comments.

If we changed the message to "Magic comments should be in the following order for consistency", would that help?

Yes, thank you for the clarification. Anything helps. Though I did find this PR here which suggests that there is in fact a technical significance at least in one case (and perhaps others?) - #120

[andyw8]

Ah, good spot. I see that RuboCop already has a cop to ensure encoding is first, so perhaps this cop should be changed to only deal with the others? Then we can simplify the explanation.

@KaanOzkan @egiurleo

[KaanOzkan]

I think it's good for the cop to be aware of encoding. It makes it slightly harder to do an incorrectly change autocorrect logic and it shows up in the error message, helping the user: Magic comments should be in the following order: encoding, typed, warn_indent, frozen_string_literal.

But yes feel free to add a brief explanation like in Andy's comment.

[marknuzz]

Thank you!