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

Readme cleanup #154

Merged
merged 5 commits into from
Nov 25, 2024
Merged

Readme cleanup #154

merged 5 commits into from
Nov 25, 2024

Conversation

firai
Copy link
Collaborator

@firai firai commented Nov 17, 2024

  • Key binding lists
    • Fix the "Esc, Ctrl-[" key binding, which would have meant pressing these in succession, to say "Esc or Ctrl-[".
    • Reword the descriptions of "Shift-Esc" and "Esc or Ctrl-[" to be more accurate.
    • Reword the descriptions for changing cell type to be similar to those in JupyterLab.
    • Consistency in abbreviations and capitalization
      • Esc
      • Cmd
    • Reorder vim bindings and Jupyter command bindings to put the corresponding bindings in the same order.
  • Elsewhere
    • Fix grammar in various places.
    • Flip order of Normal and Insert modes in the mode list, based on the order that they are entered relative to Command mode, i.e., how they would be ordered in a flow diagram.
    • Change the key binding explanation to use <kbd> tags based on semantics. (However, to retain consistency with the style in vim help files, the key bindings in the lists still use hyphens between the keys.)
    • Uniformly make mode names capitalized and "mode" itself lowercase in paragraph text. (Key binding descriptions have been left as title case only to minimize change. I wouldn't be opposed to making these sentence case.)

@firai firai added the documentation Improvements or additions to documentation label Nov 17, 2024
Copy link

Binder 👈 Launch a Binder on branch firai/jupyterlab-vim/readme-cleanup

@firai firai marked this pull request as ready for review November 18, 2024 17:51
@firai firai merged commit 9b44041 into jupyterlab-contrib:main Nov 25, 2024
5 checks passed
@firai firai deleted the readme-cleanup branch November 25, 2024 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant