orderless icon indicating copy to clipboard operation
orderless copied to clipboard

GitHub-rendered readme is "Style dispatchers" section is misleading/hard to read

Open axelson opened this issue 2 years ago • 0 comments

The "Style dispatchers" shows a formatting error:

Screenshot 2024-01-04 18-23-12

This is how I would expect that section to be rendered (I've entered it in markdown since that's what GitHub issues supports):

  • ! makes the rest of the component match using orderless-without-literal, that is, both !bad and bad! will match strings that do /not/ contain the substring bad.
  • , uses orderless-initialism.
  • = uses orderless-literal.
  • ~ uses orderless-flex.
  • % makes the string match ignoring diacritics and similar inflections on characters (it uses the function char-fold-to-regexp to do this).

When I first read this I thought it meant that you type === as the prefix to use orderless-literal which was incorrect.

I'm not sure if this is an issue with the org-mode rendering or with GitHub's interpretation of it.

axelson avatar Jan 05 '24 04:01 axelson