From 3f163a2fd4a7c9598a48f08e577a42a82f3ad9b0 Mon Sep 17 00:00:00 2001 From: Daniel Shahaf Date: Tue, 17 Nov 2015 03:02:39 +0000 Subject: [PATCH] docs copyedit: Rewrap to 80 columns, part 2. --- README.md | 12 +++++++----- highlighters/README.md | 6 ++++-- highlighters/brackets/README.md | 6 ++++-- highlighters/cursor/README.md | 3 ++- highlighters/line/README.md | 3 ++- highlighters/main/README.md | 3 ++- highlighters/pattern/README.md | 3 ++- highlighters/root/README.md | 6 ++++-- tests/README.md | 16 ++++++++++------ 9 files changed, 37 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 5ffa82c..679c2ed 100644 --- a/README.md +++ b/README.md @@ -76,10 +76,11 @@ so make it the last element of the `$plugins` array. ### System-wide installation -Either of the above methods is suitable for a single-user installation, which requires -no special privileges. If, however, you desire to install zsh-syntax-highlighting -system-wide, you may do so by running `make install` and directing your users to -add `source /usr/local/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh` +Either of the above methods is suitable for a single-user installation, +which requires no special privileges. If, however, you desire to install +zsh-syntax-highlighting system-wide, you may do so by running `make install` +and directing your users to add + `source /usr/local/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh` in their `.zshrc`s. @@ -95,7 +96,8 @@ syntax highlighting. ### How are new releases announced? -There is currently no "push" announcements channel. However, the following alternatives exist: +There is currently no "push" announcements channel. However, the following +alternatives exist: - GitHub's RSS feed of releases: https://github.com/zsh-users/zsh-syntax-highlighting/releases.atom - An anitya entry: https://release-monitoring.org/project/7552/ diff --git a/highlighters/README.md b/highlighters/README.md index 42de77e..0d104cd 100644 --- a/highlighters/README.md +++ b/highlighters/README.md @@ -14,7 +14,8 @@ Syntax highlighting is done by pluggable highlighters: How to activate highlighters ---------------------------- -To activate an highlighter, add it to the `ZSH_HIGHLIGHT_HIGHLIGHTERS` array in `~/.zshrc`, for example: +To activate an highlighter, add it to the `ZSH_HIGHLIGHT_HIGHLIGHTERS` array in +`~/.zshrc`, for example: ZSH_HIGHLIGHT_HIGHLIGHTERS=(main brackets pattern cursor) @@ -32,7 +33,8 @@ How to implement a new highlighter To create your own `myhighlighter` highlighter: -* Create your script at `highlighters/${myhighlighter}/${myhighlighter}-highlighter.zsh`. +* Create your script at + `highlighters/${myhighlighter}/${myhighlighter}-highlighter.zsh`. * Implement the `_zsh_highlight_myhighlighter_highlighter_predicate` function. This function must return 0 when the highlighter needs to be called and diff --git a/highlighters/brackets/README.md b/highlighters/brackets/README.md index d08097e..860bc5b 100644 --- a/highlighters/brackets/README.md +++ b/highlighters/brackets/README.md @@ -1,7 +1,8 @@ zsh-syntax-highlighting / highlighters / brackets ================================================= -This is the `brackets` highlighter, that highlights brackets, parenthesis and matches them. +This is the `brackets` highlighter, that highlights brackets, parenthesis and +matches them. How to activate it @@ -21,7 +22,8 @@ This highlighter defines the following styles: * `bracket-level-N` - brackets with nest level N * `cursor-matchingbracket` - the matching bracket, if cursor is on a bracket -To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`, for example in `~/.zshrc`: +To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`, +for example in `~/.zshrc`: # To define styles for nested brackets up to level 4 ZSH_HIGHLIGHT_STYLES[bracket-level-1]='fg=blue,bold' diff --git a/highlighters/cursor/README.md b/highlighters/cursor/README.md index eb65d6f..470dd0d 100644 --- a/highlighters/cursor/README.md +++ b/highlighters/cursor/README.md @@ -19,7 +19,8 @@ This highlighter defines the following styles: * `cursor` - the style for the current cursor position -To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`, for example in `~/.zshrc`: +To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`, +for example in `~/.zshrc`: ZSH_HIGHLIGHT_STYLES[cursor]='bg=blue' diff --git a/highlighters/line/README.md b/highlighters/line/README.md index 88d418b..781cf26 100644 --- a/highlighters/line/README.md +++ b/highlighters/line/README.md @@ -19,7 +19,8 @@ This highlighter defines the following styles: * `line` - the style for the whole line -To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`, for example in `~/.zshrc`: +To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`, +for example in `~/.zshrc`: ZSH_HIGHLIGHT_STYLES[line]='bold' diff --git a/highlighters/main/README.md b/highlighters/main/README.md index b128a7a..d450ed9 100644 --- a/highlighters/main/README.md +++ b/highlighters/main/README.md @@ -52,7 +52,8 @@ This highlighter defines the following styles: * `comment` - comments, when `setopt INTERACTIVE_COMMENTS` is in effect (`echo # foo`) * `default` - everything else -To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`, for example in `~/.zshrc`: +To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`, +for example in `~/.zshrc`: # Declare the variable typeset -A ZSH_HIGHLIGHT_STYLES diff --git a/highlighters/pattern/README.md b/highlighters/pattern/README.md index 8bdf929..75290f4 100644 --- a/highlighters/pattern/README.md +++ b/highlighters/pattern/README.md @@ -15,7 +15,8 @@ To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`: How to tweak it --------------- -To use this highlighter, associate patterns with styles in the `ZSH_HIGHLIGHT_PATTERNS` array, for example in `~/.zshrc`: +To use this highlighter, associate patterns with styles in the +`ZSH_HIGHLIGHT_PATTERNS` array, for example in `~/.zshrc`: # To have commands starting with `rm -rf` in red: ZSH_HIGHLIGHT_PATTERNS+=('rm -rf *' 'fg=white,bold,bg=red') diff --git a/highlighters/root/README.md b/highlighters/root/README.md index 4f2535a..8592ef7 100644 --- a/highlighters/root/README.md +++ b/highlighters/root/README.md @@ -1,7 +1,8 @@ zsh-syntax-highlighting / highlighters / root ============================================= -This is the `root` highlighter, that highlights the whole line if the current user is root. +This is the `root` highlighter, that highlights the whole line if the current +user is root. How to activate it @@ -19,7 +20,8 @@ This highlighter defines the following styles: * `root` - the style for the whole line if the current user is root. -To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`, for example in `~/.zshrc`: +To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`, +for example in `~/.zshrc`: ZSH_HIGHLIGHT_STYLES[root]='bg=red' diff --git a/tests/README.md b/tests/README.md index 6212c59..ea3717a 100644 --- a/tests/README.md +++ b/tests/README.md @@ -15,18 +15,21 @@ that is, `$i` and `$j` specify a range, 1-indexed, inclusive of both endpoints. If `$todo` exists, the test point is marked as TODO (the failure of that test point will not fail the test), and `$todo` is used as the explanation. -**Note**: `$region_highlight` uses the same `"$i $j $style"` syntax but interprets the indexes differently. +**Note**: `$region_highlight` uses the same `"$i $j $style"` syntax but +interprets the indexes differently. -**Isolation**: Each test is run in a separate subshell, so any variables, aliases, functions, etc., -it defines will be visible to the tested code (that computes `$region_highlight`), but will not affect -subsequent tests. The current working directory of tests is set to a newly-created empty directory, +**Isolation**: Each test is run in a separate subshell, so any variables, +aliases, functions, etc., it defines will be visible to the tested code (that +computes `$region_highlight`), but will not affect subsequent tests. The +current working directory of tests is set to a newly-created empty directory, which is automatically cleaned up after the test exits. Highlighting test ----------------- -[`test-highlighting.zsh`](tests/test-highlighting.zsh) tests the correctness of the highlighting. Usage: +[`test-highlighting.zsh`](tests/test-highlighting.zsh) tests the correctness of +the highlighting. Usage: zsh test-highlighting.zsh @@ -40,7 +43,8 @@ which will run all highlighting tests and report results in [TAP](http://testany Performance test ---------------- -[`test-perfs.zsh`](tests/test-perfs.zsh) measures the time spent doing the highlighting. Usage: +[`test-perfs.zsh`](tests/test-perfs.zsh) measures the time spent doing the +highlighting. Usage: zsh test-perfs.zsh