-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Added missing static commands to documentation #11152
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is auto-generated by cargo xtask docgen
- it documents the typable commands (commands you can use in command mode :
). The commands you added are static commands. They can't be used from command mode so they shouldn't have :
in front of them. Instead they're meant to be bound to keys and they take no arguments. #10970 should be solved by adding a new document for static commands that is generated by cargo xtask docgen
like this file
Working on it. |
Did everything as it's supposed to be. Sorry for the inconvenience. |
You think it would be better to create a separate doc page 2.4 for static commands? (i added a new section here) |
Yeah the page will be quite long with static and typable commands together. Let's use separate pages |
Done. |
Hi @the-mikedavis I just wanted to check in on the pull request. If you have any more feedback, please let me know. Whenever you have a moment, could you please take a look and consider merging? I would really appreciate it. |
Code-wise this looks good, just a note about the layout |
Done. |
(The CI failure is from master, not related to these changes) |
Hey, just checking on again. Will this PR be merged? |
Implementation looks good. I do wonder if we should emulate the command picker and also show default bindings here. While we already have a handwritten keymap docs it can be useful to see wether default bindings exist (and what they are) right away after finding a command here.One challenge with that is that bindings would be mode dependent I guess. I guess for now one putting the mode a command is mapped for in parenthesis could work. For example This would also cover some things missing from the keymaps docs (like c-z for suspend). I think often users can be familiar with a keybinding but may nit understand/know the bame/description (c-z is widely know, but the suspend command noch so much). Thoughts @the-mikedavis |
@pascalkuthe I could open another PR for that |
Hmm yeah that's a good idea. See the |
@pascalkuthe @the-mikedavis Done. |
b9a4332
to
5c98ffa
Compare
I noticed an issue with special characters like ` or <> in keybinds. It's messing up the markdown. Is this a thing with generating webpages too? I could make docgen put a \ before them. |
Added your suggestions, @the-mikedavis. I don't understand one thing though. Why are there duplicates? This one for example. |
f7daa47
to
267da26
Compare
Can't reopen the PR for some reason. I'll open a new one |
Added missing commands (those without keymaps) to documentation.
Documented in Issue #10970.