infra icon indicating copy to clipboard operation
infra copied to clipboard

Alternate delimiter for strings in prose

Open annevk opened this issue 7 years ago • 6 comments

Due to the strings in https://whatpr.org/fetch/831.html#example-header-list-get-decode-split containing " it all looks rather confusing. Matt Menke suggested using < and >, which seems reasonable, but perhaps there's something even more unique we could consider for such rather exceptional cases?

Alternatively I guess we can adjust the style sheet and indicate it has to account for this.

annevk avatar Nov 20 '18 09:11 annevk

I think we should stick to the existing convention. The more specs use it, the less confusing it becomes.

domenic avatar Nov 20 '18 16:11 domenic

@MattMenke2 as I don't feel too strongly and this only affects an example I think I'm going to let this slide for now. If it keeps coming up I'm happy to revisit though. Hope that's okay.

annevk avatar Nov 20 '18 16:11 annevk

I'm fine with that, but I'm not sure how accurate the claim that using <code> and non-<code> double quotes in the same string will ever become less confusing, no matter how common it is. There's no well-defined visual difference between the two types of double-quotes, IMHO.

MattMenke2 avatar Nov 20 '18 16:11 MattMenke2

Another option would be to change the color of code-tag enclosed blocks, instead of changing characters.

MattMenke2 avatar Nov 20 '18 16:11 MattMenke2

They're visually different on my system... maybe we can improve the stylesheet so that's true more generally?

image

domenic avatar Nov 20 '18 17:11 domenic

The quotes are visually different, but not that visually different. The light gray / black distinction is difficult to distinguish, with small blob-shaped characters, and the height difference isn't too significant.

Edit: Also, while I'm certainly not an expert on accessibility, I don't think that those two types of quotes would pass any reasonable accessibility audit.

MattMenke2 avatar Nov 20 '18 17:11 MattMenke2