Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a sub-section on usage of zero-width space #643

Open
haqer1 opened this issue Apr 17, 2020 · 1 comment · May be fixed by #644 or #645
Open

Add a sub-section on usage of zero-width space #643

haqer1 opened this issue Apr 17, 2020 · 1 comment · May be fixed by #644 or #645

Comments

@haqer1
Copy link

haqer1 commented Apr 17, 2020

Zero-width space is currently not mentioned in (e.g.) https://spec.commonmark.org/0.29 at all.

However, it's suggested to be used for certain cases. E.g.:
commonmark/commonmark.js#108 (comment)
commonmark/commonmark.js#148 (comment)

There are also cases where it works for single indicator of inline structure, but not for double:
commonmark/commonmark.js#174

Hence, IMHO, it's worth documenting this.

@haqer1
Copy link
Author

haqer1 commented Apr 17, 2020

FYI, I separated the suggestions into 2 PRs:

  1. Add a sub-section for Zero-width space #644: related to first 2 examples in the OP
  2. Add a few examples illustrating that zero-width space is not an equivalent of backslash escape #645: related to the last example in the OP (includes item 1. verbatim)

I don't have much more time for this, but these are my quick thoughts on improving documentation in this regard.

haqer1 added a commit to haqer1/commonmark-spec that referenced this issue Apr 24, 2020
…ro-width space may be required to satisfy left/right-flanking delimiter run rules (with reference to Emphasis and strong emphasis sub-section)

Fixes: commonmark#643
haqer1 added a commit to haqer1/commonmark-spec that referenced this issue Apr 24, 2020
…ro-width space may be required to satisfy left/right-flanking delimiter run rules (with reference to Emphasis and strong emphasis sub-section)

Fixes: commonmark#643
haqer1 added a commit to haqer1/commonmark-spec that referenced this issue Aug 3, 2020
… in relation to Zero-width space sub-section), fix up the U+ notation of the ZWS character (to match the hexadecimal HTML entity 5 words later)

Fixes: commonmark#643
haqer1 added a commit to haqer1/commonmark-spec that referenced this issue Aug 3, 2020
… in relation to Zero-width space sub-section), fix up the U+ notation of the ZWS character (to match the hexadecimal HTML entity 5 words later)

Fixes: commonmark#643
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant