[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/anzu 8f91b00c91 028/288: Improve the documentation a bit
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/anzu 8f91b00c91 028/288: Improve the documentation a bit |
Date: |
Thu, 6 Jan 2022 03:58:36 -0500 (EST) |
branch: elpa/anzu
commit 8f91b00c91fb35ec56a5a6fff3f262436bb8dbcb
Author: Bozhidar Batsov <bozhidar@tradeo.com>
Commit: Bozhidar Batsov <bozhidar@tradeo.com>
Improve the documentation a bit
---
README.md | 24 ++++++++++++++++--------
anzu.el | 9 +++++----
2 files changed, 21 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 20e55190c2..04da844e7d 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@
## Introduction
-`anzu.el` is Emacs port of [anzu.vim](https://github.com/osyo-manga/vim-anzu).
-`anzu.el` provides minor mode which display *current point* and *total matched*
-in various search mode.
+`anzu.el` is an Emacs port of
[anzu.vim](https://github.com/osyo-manga/vim-anzu).
+`anzu.el` provides a minor mode which displays *current match* and *total
matches*
+information in the mode-line in various search mode.
## Screenshot
@@ -30,11 +30,19 @@ You can install `anzu.el` from
[MELPA](http://melpa.milkbox.net/) with `package.
#### `anzu-mode`
-Enable anzu minor mode
+Enable anzu minor mode:
+
+```lisp
+(anzu-mode)
+```
#### `global-anzu-mode`
-Enable global anzu mode
+Enable global anzu mode:
+
+```lisp
+(global-anzu-mode)
+```
## Customization
@@ -74,7 +82,7 @@ For example, show search information tail of
`minor-mode-alist`
#### `anzu-use-migemo`(Default is `nil`)
-Set non-nil` if you use [migemo](https://github.com/emacs-jp/migemo).
+Set to `t` if you use [migemo](https://github.com/emacs-jp/migemo).
#### `anzu-mode-lighter`
@@ -82,10 +90,10 @@ Default is ` Anzu`.
#### `anzu-regexp-search-commands`
-Command which use regexp input. If last command is member of this list,
+Commands which have regexp input. If the last command is a member of this list,
`anzu.el` treats input as regular expression.
-Default is `'(isearch-forward-regexp isearch-backward-regexp)`.
+The default value is `'(isearch-forward-regexp isearch-backward-regexp)`.
## Sample Configuration
diff --git a/anzu.el b/anzu.el
index 7969cef567..b768f09ed5 100644
--- a/anzu.el
+++ b/anzu.el
@@ -21,11 +21,12 @@
;;; Commentary:
-;; `anzu.el' is Port of `anzu.vim'.
+;; `anzu.el' is an Emacs port of `anzu.vim'.
;;
-;; `anzu.el' provides minor-mode which display 'current-posion/total matches'
-;; to mode-line in various search modes. You can understand that how many
-;; does your searched word match in current buffer.
+;; `anzu.el' provides a minor mode which displays 'current match/total
+;; matches' in the mode-line in various search modes. This makes it
+;; easy to understand how many matches there are in the current buffer
+;; for your search query.
;; To use this package, add following code to your init.el or .emacs
;; (require 'anzu)
- [nongnu] elpa/anzu c2f8cbc234 016/288: Fix header, (continued)
- [nongnu] elpa/anzu c2f8cbc234 016/288: Fix header, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu f570e01b4c 032/288: Merge pull request #8 from bbatsov/doc-improvement, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu f57d1e6ceb 033/288: bump up version and update Changes, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 1afa7d7b0f 013/288: Add flag whether anzu.el cons search info to mode-line(#4), ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu e9bb490b65 003/288: Update document, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 9de45b406c 004/288: add sample, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 9ab3cfa390 007/288: Merge pull request #3 from kiwanami/master, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu e39deb4aec 011/288: Add comment section, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 6fda98326a 024/288: input is regexp if isearch-regexp is non-nil, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 9ec5a834cf 025/288: Bump up version and update Changes, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 8f91b00c91 028/288: Improve the documentation a bit,
ELPA Syncer <=
- [nongnu] elpa/anzu b644e9d067 034/288: Better one-line description, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 06ae1b1f7e 035/288: Merge pull request #9 from purcell/patch-1, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 06f4cf2fe7 037/288: Introduce anzu-minimum-input-length, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu e82b3d4236 069/288: Use delimiter regexp at anzu-query-replace-at-cursor, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu b211f9a50f 067/288: Bump up version and update Changes, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 4f024cd623 081/288: Clear last input cache after isearch command, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 3a7fcf2096 094/288: Merge pull request #14 from syohex/fix-increasing-anzuinfo-issue, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 537b8bfd36 071/288: Add autoload cookie, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu 6b01763088 077/288: Improve replace regular expression, ELPA Syncer, 2022/01/06
- [nongnu] elpa/anzu abd5953eac 018/288: Add Installation section, ELPA Syncer, 2022/01/06