Skip to content

Commit 4d831b5

Browse files
authored
Fix broken markdown in auto-generated keybindings documentation (#4690)
- **PR Description** This PR fixes the broken markdown table formatting in the auto-generated keybindings documentation files by properly escaping newlines in tooltips. Issue: #4689
2 parents bc4b50f + b11da41 commit 4d831b5

File tree

10 files changed

+56
-153
lines changed

10 files changed

+56
-153
lines changed

docs/keybindings/Keybindings_en.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
9191
| `` R `` | Reword with editor | |
9292
| `` d `` | Drop | Drop the selected commit. This will remove the commit from the branch via a rebase. If the commit makes changes that later commits depend on, you may need to resolve merge conflicts. |
9393
| `` e `` | Edit (start interactive rebase) | Edit the selected commit. Use this to start an interactive rebase from the selected commit. When already mid-rebase, this will mark the selected commit for editing, which means that upon continuing the rebase, the rebase will pause at the selected commit to allow you to make changes. |
94-
| `` i `` | Start interactive rebase | Start an interactive rebase for the commits on your branch. This will include all commits from the HEAD commit down to the first merge commit or main branch commit.
95-
If you would instead like to start an interactive rebase from the selected commit, press `e`. |
94+
| `` i `` | Start interactive rebase | Start an interactive rebase for the commits on your branch. This will include all commits from the HEAD commit down to the first merge commit or main branch commit.<br>If you would instead like to start an interactive rebase from the selected commit, press `e`. |
9695
| `` p `` | Pick | Mark the selected commit to be picked (when mid-rebase). This means that the commit will be retained upon continuing the rebase. |
9796
| `` F `` | Create fixup commit | Create 'fixup!' commit for the selected commit. Later on, you can press `S` on this same commit to apply all above fixup commits. |
9897
| `` S `` | Apply fixup commits | Squash all 'fixup!' commits, either above the selected commit, or all in current branch (autosquash). |
@@ -109,9 +108,7 @@ If you would instead like to start an interactive rebase from the selected commi
109108
| `` y `` | Copy commit attribute to clipboard | Copy commit attribute to clipboard (e.g. hash, URL, diff, message, author). |
110109
| `` o `` | Open commit in browser | |
111110
| `` n `` | Create new branch off of commit | |
112-
| `` N `` | Move commits to new branch | Create a new branch and move the unpushed commits of the current branch to it. Useful if you meant to start new work and forgot to create a new branch first.
113-
114-
Note that this disregards the selection, the new branch is always created either from the main branch or stacked on top of the current branch (you get to choose which). |
111+
| `` N `` | Move commits to new branch | Create a new branch and move the unpushed commits of the current branch to it. Useful if you meant to start new work and forgot to create a new branch first.<br><br>Note that this disregards the selection, the new branch is always created either from the main branch or stacked on top of the current branch (you get to choose which). |
115112
| `` g `` | Reset | View reset options (soft/mixed/hard) for resetting onto selected item. |
116113
| `` C `` | Copy (cherry-pick) | Mark commit as copied. Then, within the local commits view, you can press `V` to paste (cherry-pick) the copied commit(s) into your checked out branch. At any time you can press `<esc>` to cancel the selection. |
117114
| `` <c-t> `` | Open external diff tool (git difftool) | |
@@ -169,9 +166,7 @@ Note that this disregards the selection, the new branch is always created either
169166
| `` i `` | Show git-flow options | |
170167
| `` <space> `` | Checkout | Checkout selected item. |
171168
| `` n `` | New branch | |
172-
| `` N `` | Move commits to new branch | Create a new branch and move the unpushed commits of the current branch to it. Useful if you meant to start new work and forgot to create a new branch first.
173-
174-
Note that this disregards the selection, the new branch is always created either from the main branch or stacked on top of the current branch (you get to choose which). |
169+
| `` N `` | Move commits to new branch | Create a new branch and move the unpushed commits of the current branch to it. Useful if you meant to start new work and forgot to create a new branch first.<br><br>Note that this disregards the selection, the new branch is always created either from the main branch or stacked on top of the current branch (you get to choose which). |
175170
| `` o `` | Create pull request | |
176171
| `` O `` | View create pull request options | |
177172
| `` <c-y> `` | Copy pull request URL to clipboard | |
@@ -272,9 +267,7 @@ Note that this disregards the selection, the new branch is always created either
272267
| `` y `` | Copy commit attribute to clipboard | Copy commit attribute to clipboard (e.g. hash, URL, diff, message, author). |
273268
| `` o `` | Open commit in browser | |
274269
| `` n `` | Create new branch off of commit | |
275-
| `` N `` | Move commits to new branch | Create a new branch and move the unpushed commits of the current branch to it. Useful if you meant to start new work and forgot to create a new branch first.
276-
277-
Note that this disregards the selection, the new branch is always created either from the main branch or stacked on top of the current branch (you get to choose which). |
270+
| `` N `` | Move commits to new branch | Create a new branch and move the unpushed commits of the current branch to it. Useful if you meant to start new work and forgot to create a new branch first.<br><br>Note that this disregards the selection, the new branch is always created either from the main branch or stacked on top of the current branch (you get to choose which). |
278271
| `` g `` | Reset | View reset options (soft/mixed/hard) for resetting onto selected item. |
279272
| `` C `` | Copy (cherry-pick) | Mark commit as copied. Then, within the local commits view, you can press `V` to paste (cherry-pick) the copied commit(s) into your checked out branch. At any time you can press `<esc>` to cancel the selection. |
280273
| `` <c-r> `` | Reset copied (cherry-picked) commits selection | |
@@ -356,9 +349,7 @@ Note that this disregards the selection, the new branch is always created either
356349
| `` y `` | Copy commit attribute to clipboard | Copy commit attribute to clipboard (e.g. hash, URL, diff, message, author). |
357350
| `` o `` | Open commit in browser | |
358351
| `` n `` | Create new branch off of commit | |
359-
| `` N `` | Move commits to new branch | Create a new branch and move the unpushed commits of the current branch to it. Useful if you meant to start new work and forgot to create a new branch first.
360-
361-
Note that this disregards the selection, the new branch is always created either from the main branch or stacked on top of the current branch (you get to choose which). |
352+
| `` N `` | Move commits to new branch | Create a new branch and move the unpushed commits of the current branch to it. Useful if you meant to start new work and forgot to create a new branch first.<br><br>Note that this disregards the selection, the new branch is always created either from the main branch or stacked on top of the current branch (you get to choose which). |
362353
| `` g `` | Reset | View reset options (soft/mixed/hard) for resetting onto selected item. |
363354
| `` C `` | Copy (cherry-pick) | Mark commit as copied. Then, within the local commits view, you can press `V` to paste (cherry-pick) the copied commit(s) into your checked out branch. At any time you can press `<esc>` to cancel the selection. |
364355
| `` <c-r> `` | Reset copied (cherry-picked) commits selection | |

0 commit comments

Comments
 (0)