docs: add default keybinding maps available in the help#506
docs: add default keybinding maps available in the help#506harrisoncramer merged 5 commits intoharrisoncramer:developfrom
Conversation
Fix: Jumping to renamed files (harrisoncramer#484) Fix: Store reviewer data before creating comment popup (harrisoncramer#476) Fix: Make publishing drafts more robust (harrisoncramer#483) Fix: Swap file_name and old_file_name in reviewer data (harrisoncramer#485) --------- Co-authored-by: Jakub F. Bortlík <jakub.bortlik@proton.me>
* Fix: Jumping to renamed files (harrisoncramer#484) * fix: prevent "cursor position outside buffer" error * fix: swap file_name and old_file_name in reviewer data `old_file_name` is not set to the empty string for un-renamed files anymore, because then we can remove the empty-line check in `comment_helpers.go` which was used to replace the empty string with the current file name anyway. * fix: add old_file_name to discussion root node data * fix: also consider old_file_name when jumping to the reviewer This fixes jumping to renamed files, however, may not work for comments that were created on renamed files with the previous version of `gitlab.nvim` as that version assigned the `file_name` and `old_file_name` incorrectly. * refactor: don't shadow variable * fix: check file_name or old_file_name based on which SHA comment belongs to * Fix: Store reviewer data before creating comment popup (harrisoncramer#476) * Fix: Make publishing drafts more robust (harrisoncramer#483) * Fix: Swap file_name and old_file_name in reviewer data (harrisoncramer#485) * Feat: Enable toggling date format between relative and absolute (harrisoncramer#491) * Fix: Add opts to help popup (harrisoncramer#492) * Fix: Force start_line for jumping to diagnostic to be inside buffer (harrisoncramer#494) * fix: redefine colors after reloading colorscheme (harrisoncramer#500) * Fix: Use path instead of oldpath as fallback for unrenamed files (harrisoncramer#496) * Fix: Use file_name when old_file_name is not set (harrisoncramer#495) * fix(ci): fix lua tests (harrisoncramer#501) * Proxy Support (harrisoncramer#499) This is a #MINOR release. --------- Co-authored-by: Jakub F. Bortlík <jakub.bortlik@proton.me> Co-authored-by: Jonathan Duck <Duckbrain30@gmail.com>
README.md
Outdated
| a Jump to the comment in the discussion tree | ||
| ``` | ||
|
|
||
| The plugin sets up a number of useful keybindings in the special buffers it creates, and some global keybindings as well. Refer to the relevant section of the manual `:h gitlab.nvim.keybindings` for more details. |
There was a problem hiding this comment.
You should merge this line with the information under the Keybindings heading.
README.md
Outdated
| # gitlab.nvim | ||
| gitlab.nvim | ||
| =========== |
There was a problem hiding this comment.
Hi @makbari. Your contribution is appreciated. Just a suggestion: These style changes don't seem to be necessary, they are not mentioned in the PR description, and so they make the review more difficult as the reviewer has to look for the substantial changes which are advertised in the description. So I think you might just as well revert the style changes.
There was a problem hiding this comment.
Hi there,
Sorry, i oversee this, it was automatic change via a plugin. a good reminder that i need to check the changes with more open eyes 👀
|
Hey this looks good to me and I'm happy to merge it in, but could you please change the target branch to develop and merge in latest? Then I'll merge it in. That's our regular release pattern. |
|
Hi, the call is obviously Harrison's but I'd rather not add the keybindings to the README. It would be the third place to keep in sync with doc/gitlab.nvim.txt and lua/gitlab/state.lua. To me the two existing documents are already enough 😄 I mean, I appreciate your effort @makbari, but in my view, the information is quite easy to find already. |
|
@jakubbortlik Thanks for pointing out. I did not know about those files. Indeed, these files are more than enough. For myself, i found the keybinding in the help doc in |
Hi @makbari, to make the keybindings more easily accessible online, I'd consider adding a hyperlink to the |
|
Thanks for your contribution! @jakubbortlik if there's anything you want to add/change here let's do it in a follow-up PR, don't want to hold up makbari any longer here since it's just a docs change and he's been so patient. |
* Fix: Jumping to renamed files (#484) * fix: prevent "cursor position outside buffer" error * fix: swap file_name and old_file_name in reviewer data `old_file_name` is not set to the empty string for un-renamed files anymore, because then we can remove the empty-line check in `comment_helpers.go` which was used to replace the empty string with the current file name anyway. * fix: add old_file_name to discussion root node data * fix: also consider old_file_name when jumping to the reviewer This fixes jumping to renamed files, however, may not work for comments that were created on renamed files with the previous version of `gitlab.nvim` as that version assigned the `file_name` and `old_file_name` incorrectly. * refactor: don't shadow variable * fix: check file_name or old_file_name based on which SHA comment belongs to * Fix: Store reviewer data before creating comment popup (#476) * Fix: Make publishing drafts more robust (#483) * Fix: Swap file_name and old_file_name in reviewer data (#485) * Feat: Enable toggling date format between relative and absolute (#491) * Fix: Add opts to help popup (#492) * Fix: Force start_line for jumping to diagnostic to be inside buffer (#494) * fix: redefine colors after reloading colorscheme (#500) * Fix: Use path instead of oldpath as fallback for unrenamed files (#496) * Fix: Use file_name when old_file_name is not set (#495) * fix(ci): fix lua tests (#501) * Proxy Support (#499) * feat(ci): Cancel obsolete after a new commit is pushed in an open PR (#503) * fix: start and clean up winbar timer properly (#513) This is a PATCH. * fix: put attach_file markdown on new line (#512) This is a PATCH PR. * docs: fix incorrect value for 'relative' option to Split (#511) This is a PATCH. * docs: add default keybinding maps available in the help (#506) This is a PATCH change. * feat: enable setting discussion tree options (#509) * docs: add description of `refresh_data` function * fix: only set gitlab filetype in one place * feat: set some useful window options for the discussion tree split This is a PATCH PR. --------- Co-authored-by: Jakub F. Bortlík <jakub.bortlik@proton.me> Co-authored-by: Jonathan Duck <Duckbrain30@gmail.com> Co-authored-by: Kitsios Konstantinos <kitsios.konst@gmail.com> Co-authored-by: Mohammad Akbari <makbari@users.noreply.github.com>
3 participants
Description
Updated
README.mdfile with the default keymapings available in:h gitlab.nvim.keybindings.