Enforce single-hash comments

[MichaelChirico]

The guide has https://style.tidyverse.org/functions.html#comments:

In code, use comments to explain the “why” not the “what” or “how”. Each line of a comment should begin with the comment symbol and a single space: #.

That should fix something like:

## my code

This latter is used by e.g. ESS and Bioconductor

https://contributions.bioconductor.org/r-code.html#rcode-comments

https://ess.r-project.org/Manual/ess.html#Indenting-and-formatting-R-code

[lorenzwalthert]

Hi @MichaelChirico. I see. So you propose to strip additional # for scope = 'tokens'? I get what you mean, although IMU the style guide does not say something like do not use multiple #. I image this to be potentially unexpected on existing code. Would you distinguish between these cases?

1 + 1 # comment 
# this is full line comment

[MichaelChirico]

You're right that the wording is not 100% explicit; I filed tidyverse/style#258. Personally I rarely see this style ## outside the cited style guides.

I wouldn't distinguish those cases.

There do seem to me to be cases where ## is "ok", but require some discernment -- # is the default and ## applies rarely. But I can't think of any static rule to distinguish them, so maybe we don't want this to live in {styler} after all...