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

Delete unexpected chars within pairs of ~ #14454

Conversation

rayw000
Copy link
Contributor

@rayw000 rayw000 commented Mar 3, 2021

Unexpected chars break style of quoted key bindings in documents. For example: https://develop.spacemacs.org/layers/+tools/shell/README.html#key-bindings

image

More similar commits will come later after this one gets approved.

Unexpected chars break the style of quoted key bindings in documents.

More similar commits will come later after this one gets approved.
@duianto
Copy link
Collaborator

duianto commented Mar 4, 2021

The ZERO WIDTH SPACE character before the closing tilde seems to have been added to hide the tilde characters around the key bindings when the readme is read on GitHub.

Minor fix of the rendering of key binding #2699
Fix inline code block #5297
Fix inline code blocks #5305

That's why the tilde characters are not visible on the current Spacemacs shell readme page:
https://github.com/syl20bnr/spacemacs/tree/develop/layers/%2Btools/shell#key-bindings

But they are visible on your fork (this PR):
https://github.com/rayw000/spacemacs/tree/delete-unexpected-chars-within-wave-pairs/layers/%2Btools/shell

It's been suggested to remove them before:
Fix formatting in Latex layer README.org #12704

The source of the issue seems to be that the tool that GitHub uses to parse org files org-ruby, doesn't handle quotes, commas, etc. before a tilde.

It's been reported upstream: Aug 13, 2020
wallyqs/org-ruby#36 (comment)

I reported this issue to the Org mode developers and the spec is now updated and allows any characters but whitespace in the border - https://orgmode.org/worg/dev/org-syntax.html#Emphasis_Markers.

The latest org-ruby commit is from May 19, 2020, so they might not have updated to handle the latest org mode syntax.

@rayw000
Copy link
Contributor Author

rayw000 commented Mar 4, 2021

Thank you @duianto

I've read all you posted. No wonder every ZWS appears before a quote.

How would you think if I leave this PR opened before Github upgrades its org-ruby to the latest version?

@duianto
Copy link
Collaborator

duianto commented Mar 4, 2021

How would you think if I leave this PR opened before Github upgrades its org-ruby to the latest version?

Sure.

They might be working on update.
Update gem
wallyqs/org-ruby#86

@github-actions
Copy link

This PR has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Please let us know if this PR is still need merging!

@github-actions github-actions bot added the stale marked as a stale issue/pr (usually by a bot) label Apr 10, 2023
@github-actions github-actions bot closed this Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale marked as a stale issue/pr (usually by a bot) Waiting for upstream
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants