From 992b9de5050f38cdefee26dc020175506c8469a2 Mon Sep 17 00:00:00 2001 From: Indrajit Raychaudhuri Date: Fri, 12 Oct 2018 10:52:24 -0500 Subject: [PATCH] doc: More copyediting and formatting for consistency --- modules/archive/README.md | 6 +++--- modules/autosuggestions/README.md | 5 ----- modules/command-not-found/README.md | 7 ++++--- modules/environment/README.md | 14 +++++++------- modules/python/README.md | 8 +++++--- modules/utility/README.md | 7 ++++--- 6 files changed, 23 insertions(+), 24 deletions(-) diff --git a/modules/archive/README.md b/modules/archive/README.md index 600ff15..c9806ea 100644 --- a/modules/archive/README.md +++ b/modules/archive/README.md @@ -31,9 +31,9 @@ installed: - *.7z* requires `7za`. - *.deb* requires `ar`, `tar`. -Additionally, if `pigz` and/or `pbzip2` are installed, `archive` will use them over -their traditional counterparts, `gzip` and `bzip2` respectively, to take full advantage -of all available CPU cores for compression. +Additionally, if `pigz` and/or `pbzip2` are installed, `archive` will use them +over their traditional counterparts, `gzip` and `bzip2` respectively, to take +full advantage of all available CPU cores for compression. Alternatives ------------ diff --git a/modules/autosuggestions/README.md b/modules/autosuggestions/README.md index c3e90a4..48f9852 100644 --- a/modules/autosuggestions/README.md +++ b/modules/autosuggestions/README.md @@ -1,8 +1,3 @@ -Autosuggestions ---------------- - -Integrates zsh-autosuggestions into Prezto. - Autosuggestions =============== diff --git a/modules/command-not-found/README.md b/modules/command-not-found/README.md index 7775c92..ee5a94d 100644 --- a/modules/command-not-found/README.md +++ b/modules/command-not-found/README.md @@ -3,11 +3,12 @@ Command-Not-Found When you try to use a command that is not available locally, searches the package manager for a package offering that command and suggests -the proper install command. +the proper install command. -Debian-based and Arch Linux-based distributions use the [`command-not-found`][1] tool. +Debian and Arch Linux based distributions use the [`command-not-found`][1] tool. -macOS uses Homebrew's [`command-not-found` clone][2]. Note that you also need to [follow the instructions to tap the `command-not-found` homebrew repository][3]. +macOS uses Homebrew's [`command-not-found` clone][2]. Note that you also need to +[follow the instructions][3] to tap the `command-not-found` homebrew repository. Authors diff --git a/modules/environment/README.md b/modules/environment/README.md index 6a5e582..15ee959 100644 --- a/modules/environment/README.md +++ b/modules/environment/README.md @@ -5,6 +5,13 @@ Sets general shell options and defines environment variables. This module must be loaded first. +Contributors +------------ + +This module **MUST NOT** rely on any command not built in Zsh. + +Non-interactive environment variables should be defined in [`zshenv`][1]. + Options ------- @@ -38,13 +45,6 @@ Variables - `LESS_TERMCAP_ue` ends underline. - `LESS_TERMCAP_us` begins underline. -Contributors ------------- - -This module **MUST NOT** rely on any command not built in Zsh. - -Non-interactive environment variables should be defined in [`zshenv`][1]. - Authors ------- diff --git a/modules/python/README.md b/modules/python/README.md index e7b72c4..121ea37 100644 --- a/modules/python/README.md +++ b/modules/python/README.md @@ -6,7 +6,9 @@ Enables local Python and local Python package installation. Settings -------- -This module supports virtual environments from conda and virtualenvwrapper. By default, only virtualenvwrapper is enabled. To disable virtualenvwrapper, add the following to *zpreztorc*. +This module supports virtual environments from conda and virtualenvwrapper. By +default, only virtualenvwrapper is enabled. To disable virtualenvwrapper, add +the following to *zpreztorc*. ```sh zstyle ':prezto:module:python' skip-virtualenvwrapper-init 'on' @@ -52,8 +54,8 @@ virtualenvwrapper [`virtualenvwrapper`][2] is a frontend to the popular [`virtualenv`][3] utility. -`virtualenv` creates isolated Python environments and `virtualenvwrapper` provides -convenient shell functions to create, switch, and manage them. +`virtualenv` creates isolated Python environments and `virtualenvwrapper` +provides convenient shell functions to create, switch, and manage them. ### Usage diff --git a/modules/utility/README.md b/modules/utility/README.md index 84e81f5..9ace1eb 100644 --- a/modules/utility/README.md +++ b/modules/utility/README.md @@ -8,8 +8,8 @@ Settings ### Highlighting -If you have enabled color globally in *zpreztorc*, you may disable it for certain -commands. +If you have enabled color globally in *zpreztorc*, you may disable it for +certain commands. To disable `ls` color, add the following line to *zpreztorc*; when coloring is disabled, type indicators (\*, /, =>, @, =, |, %) will be appended to entries. @@ -109,7 +109,8 @@ Aliases ### Resource Usage - - `df` displays free disk space using human readable units (aliases to `pydf`, if installed). + - `df` displays free disk space using human readable units (aliases to `pydf`, + if installed). - `du` displays disk usage using human readable units. - `top` displays information about processes. - `topc` displays information about processes sorted by CPU usage.