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

Possible misunderstanding in the keymap docs #10529

Open
cychen2021 opened this issue Apr 20, 2024 · 1 comment
Open

Possible misunderstanding in the keymap docs #10529

cychen2021 opened this issue Apr 20, 2024 · 1 comment
Labels
A-documentation Area: Documentation improvements C-bug Category: This is a bug

Comments

@cychen2021
Copy link

cychen2021 commented Apr 20, 2024

Summary

The table in the goto mode section of the keymap docs may cause misunderstanding.

IMG_6168(20240420-195859)

The <n> in the description column doesn't appear in the key column. This is a bit confusing. I spent some time figuring out how to jump to a specific line with a line number <n> by myself.

Maybe splitting this keymap into two rows is better:

Key Description Command
<n>g Go to line number n ...
g Go to the start of the file ...
@cychen2021 cychen2021 added the C-bug Category: This is a bug label Apr 20, 2024
@the-mikedavis
Copy link
Member

gg needs a few sentences to explain properly: it's going to the start of the file if there is no count and to count's line number if there is a count. I think we could add a small section near the top (above the "Normal mode" section maybe) that explains the count with examples like 3w and 10gg/g10g. Then g in goto mode can point back to the docs on count.

@the-mikedavis the-mikedavis added the A-documentation Area: Documentation improvements label Apr 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation improvements C-bug Category: This is a bug
Projects
None yet
Development

No branches or pull requests

2 participants