Skip to content

Commit

Permalink
Add docs for the ic text object
Browse files Browse the repository at this point in the history
This addresses tomtom#255 and
tomtom#188. It also partially
addresses tomtom#237 (by making
it clear that the functionality exists, even if it doesn't quite do
what's being asked for there).
  • Loading branch information
atomictom committed Dec 30, 2019
1 parent ee03e6e commit 5af53f4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/tags
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,5 @@ tcomment-debug tcomment.txt /*tcomment-debug*
tcomment-maps tcomment.txt /*tcomment-maps*
tcomment-new-filetype tcomment.txt /*tcomment-new-filetype*
tcomment-operator tcomment.txt /*tcomment-operator*
tcomment-textobject tcomment.txt /*tcomment-textobject*
tcomment.txt tcomment.txt /*tcomment.txt*
12 changes: 12 additions & 0 deletions doc/tcomment.txt
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,14 @@ A secondary set of key maps is defined for normal and insert mode (see also
<Leader>__ :: :TComment
<Leader>_i :: :TCommentInline

*tcomment-textobject*

A text object is also added for selecting an inner-comment:

{operator}ic :: Operate on the inner comment. The mapping can be changed
using the `g:tcomment_textobject_inlinecomment` variable
or disabled by setting it to the empty string, `''`.



-----------------------------------------------------------------------
Expand Down Expand Up @@ -256,6 +264,10 @@ g:tcomment_mapleader_uncomment_anyway (default: 'g<')
g:tcomment_mapleader_comment_anyway (default: 'g>')
See |tcomment-operator|.

*g:tcomment_textobject_inlinecomment*
g:tcomment_textobject_inlinecomment (default: 'ic')
See |tcomment-textobject|.

*:TComment*
:[range]TComment[!] ?ARGS...
If there is a visual selection that begins and ends in the same line,
Expand Down

0 comments on commit 5af53f4

Please sign in to comment.