search

grafana / writers-toolkit

Technical documentation guidelines for Grafana Labs documentation
https://grafana.com/docs/writers-toolkit/
16 stars 12 forks source link

Catch possessives with ’ (right single quotation mark) #744

Closed jdbaldry closed 2 weeks ago

jdbaldry commented 3 weeks ago

Found in https://github.com/grafana/website/pull/20363/files#diff-33bcdea2dcb5b53fb71bae08c05fd9fadeb28804226f7b629e09f019a26365f3R37

jdbaldry commented 3 weeks ago

Looks good. Is there any "rule" for cleaning up right single quotes vs straight? Do we need to care?

Mm, that may have been a better way to address this actually.

I think we should generally avoid smart quotes and unicode variants when ASCII characters are suitable but I've not read enough about this to have a strong argument for that.

clayton-cornell commented 3 weeks ago

I've seen a real mix. Not sure what inserts smart quotes. My editors default to straight single and double qotes.

jdbaldry commented 3 weeks ago

I've seen a real mix. Not sure what inserts smart quotes. My editors default to straight single and double qotes.

I think it may be a Mac feature: https://support.apple.com/en-gb/guide/mac-help/mh35735/mac#:~:text=the%20command%20again.-,Use%20smart%20quotes%20and%20dashes,-Automatically%20convert%20straight

jdbaldry commented 2 weeks ago

I'm gonna merge this for now but if I come across another issue with smart quotes, I'll refactor the linting rules to separately catch those characters.