[nongnu] elpa/evil-nerd-commenter 5833d2587c 122/235: updated README on invert comment

[ELPA Syncer]

branch: elpa/evil-nerd-commenter
commit 5833d2587ca423bf16a3d849654d1869551c0c3b
Author: Chen Bin <chenbin.sh@gmail.com>
Commit: Chen Bin <chenbin.sh@gmail.com>

    updated README on invert comment
---
 README.org             | 2 ++
 evil-nerd-commenter.el | 6 ++++--
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/README.org b/README.org
index bce9059d56..f4b7b0cb44 100644
--- a/README.org
+++ b/README.org
@@ -95,6 +95,7 @@ The hotkey is ",cc" in evil-mode and "C-c c" in emacs normal 
mode.
 toggle the flag to comment/uncomment empty lines.
 
 The hotkey is ",cv" in evil-mode.
+
 *** evilnc-copy-to-line
 Copy from the current line to the user-specified line.
 
@@ -112,6 +113,7 @@ Toggle flag evilnc-invert-comment-line-by-line.
 
 When the flag is true, the command "evilnc-comment-or-uncomment-lines", 
"evilnc-comment-or-uncomment-to-the-line", and 
"evilnc-comment-or-uncomment-paragraphs" will be influenced. They will *invert* 
each line's comment status instead comment the whole thing.
 
+Please note this command does NOT work on evil text object.
 *** evilnc-kill-to-line
 Kill from the current line to the user-specified line.
 
diff --git a/evil-nerd-commenter.el b/evil-nerd-commenter.el
index a5d33cbb23..353fad83c3 100644
--- a/evil-nerd-commenter.el
+++ b/evil-nerd-commenter.el
@@ -85,7 +85,8 @@
 ;;; Code:
 
 (defvar evilnc-invert-comment-line-by-line nil
-  "if t then invert region comment status line by line")
+  "If t then invert region comment status line by line.
+Please note it has NOT effect on evil text object!")
 
 ;; shamelessly copied from goto-line
 (defun evilnc--goto-line (line)
@@ -249,7 +250,7 @@
     ))
 
 (defun evilnc--invert-comment (beg end)
-  "scan the region line by line, invert its comment status"
+  "Scan the region line by line, invert its comment status"
   (let (done b e)
     (save-excursion
       (goto-char end)
@@ -435,6 +436,7 @@ or 'C-u 3 M-x 
evilnc-quick-comment-or-uncomment-to-the-line' to comment to the l
 
 ;;;###autoload
 (defun evilnc-toggle-invert-comment-line-by-line ()
+  "Please note this command does NOT work on evil text objects"
   (interactive)
   (if evilnc-invert-comment-line-by-line
       (setq evilnc-invert-comment-line-by-line nil)