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

Docs have some notation inconsistencies #1823

Closed
Josh-Tilles opened this issue Jun 2, 2015 · 6 comments
Closed

Docs have some notation inconsistencies #1823

Josh-Tilles opened this issue Jun 2, 2015 · 6 comments
Labels

Comments

@Josh-Tilles
Copy link
Contributor

There are two consistency problems that I've come across:

  1. Sometimes keybindings are just written in backticks (example: M-m f f) and other times they're written using HTML <kbd> markup (example: M-m f f).
  2. Sometimes the spacebar is written in keybindings with angle brackets (example: <SPC> f f) and other times without (example: SPC f f).
Josh-Tilles added a commit to Josh-Tilles/spacemacs that referenced this issue Jun 2, 2015
@cpaulik
Copy link
Contributor

cpaulik commented Jun 3, 2015

While this should probably be consistent I think it might be not worth it to fix this in markdown in light of #1568

@Josh-Tilles
Copy link
Contributor Author

@cpaulik good to know about. Thanks!

@syl20bnr
Copy link
Owner

syl20bnr commented Jun 3, 2015

The export script will surely take care about the conversion so it is OK to fix them in markdown too. I'll make sure to merge the markdown fixes before converting to org :-)

Josh-Tilles added a commit to Josh-Tilles/spacemacs that referenced this issue Jun 3, 2015
Josh-Tilles added a commit to Josh-Tilles/spacemacs that referenced this issue Jun 5, 2015
@person808
Copy link
Contributor

I believe I have fixed these inconsistencies in #1939

@StreakyCobra
Copy link
Contributor

There are only few places left in the documentation containing either <kbd> or <SPC>. I'll let this issue for beginners.

robert-m-johnson added a commit to robert-m-johnson/spacemacs that referenced this issue Mar 20, 2016
Replace all occurrences of <SPC> in org files with SPC.

Fixes syl20bnr#1823
StreakyCobra pushed a commit that referenced this issue Apr 5, 2016
Replace all occurrences of <SPC> in org files with SPC.

Fixes #1823
@github-actions
Copy link

This issue 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 issue is still valid!

@github-actions github-actions bot added the stale marked as a stale issue/pr (usually by a bot) label Feb 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants