From 882622d0bac48141bd3f975fae0730da585ef67d Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Sat, 23 Jun 2018 16:22:59 +1200 Subject: Update documentation to reflect changes Also remove the part about the alternative implementation, it doesn't actually do everything this plugin does. --- README.md | 4 ++-- doc/fixed_join.txt | 21 ++++++--------------- 2 files changed, 8 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a707ef1..82b9bab 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ fixed\_join.vim =============== -This plugin provides a mapping target and an optional command to `:join` lines -in normal mode while keeping the cursor in-place. +This plugin provides a mapping target to `:join` lines in normal mode while +keeping the cursor in place, and still supporting a count prefix. License ------- diff --git a/doc/fixed_join.txt b/doc/fixed_join.txt index 57c623c..da5c4b4 100644 --- a/doc/fixed_join.txt +++ b/doc/fixed_join.txt @@ -2,8 +2,8 @@ DESCRIPTION *fixed_join* -This plugin provides a mapping target and an optional command to `:join` lines -in normal mode while keeping the cursor in-place. +This plugin provides a mapping target to `:join` lines in normal mode while +keeping the cursor in place and still supporting a count prefix. REQUIREMENTS *fixed_join-requirements* @@ -12,21 +12,12 @@ This plugin is only available if 'compatible' is not set. MAPPINGS *fixed_join-mappings* *FixedJoin* -This plugin provides a mapping target |FixedJoin| to create a binding -for a user to `:join` lines in normal mode without the cursor jumping around. +A single mapping target |FixedJoin| is provided for a user to `:join` +lines in normal mode without the cursor jumping around. If the user's configuration does not specify a mapping to this target by the -time this plugin is loaded, it will attempt to map 'J' in normal mode to -simply replace the default functionality. - -ALTERNATIVE *fixed-join-alternative* - -If you don't mind clobbering a mark, this whole plugin can be replaced with -one mapping in your |vimrc|: -> - :nnoremap J mzJ`z -< -This was what the author was doing before writing this plugin as an exercise. +time this plugin is loaded, it will attempt to remap normal |J| to replace its +default function. AUTHOR *fixed_join-author* -- cgit v1.2.3