zimfw/modules/completion/README.md

completion
==========

Enables and configures smart and extensive tab completion.

Completions are sourced from [zsh-completions][zsh-completions].

Zsh options
-----------

  * `ALWAYS_TO_END` moves cursor to end of word if a full completion is inserted.
  * `PATH_DIRS` performs path search even on command names with slashes in them.
  * `NO_CASE_GLOB` makes globbing case insensitive.
  * `NO_LIST_BEEP` doesn't beep on ambiguous completions.

Contributing
------------

Command completions should be submitted [upstream to zsh-completions][zsh-completions].

[zsh-completions]: https://github.com/zsh-users/zsh-completions
[completion] Update init.zsh and README.md and use local string variable instead of "hardcoding" the string inside `${}`. 2018-05-24 21:37:16 -04:00			`completion`
add completion documentation 2015-12-15 02:07:30 -05:00			`==========`

			`Enables and configures smart and extensive tab completion.`

[completion] Add options to README.md Prefer `setopt NO_FOO` instead of `unsetopt FOO`, as former is easier to document in the README. Stick with the following style for the README: * Header 1 with the module name is in `lowercase`. * Other headers are in `Sentence case`. Common header names that should be consistently used are `Aliases`, `Contributing`, `Functions`, `Settings`, and `Zsh options`. 2018-12-15 16:54:32 -05:00			`Completions are sourced from [zsh-completions][zsh-completions].`

			`Zsh options`
			`-----------`

			* `ALWAYS_TO_END` moves cursor to end of word if a full completion is inserted.
			* `PATH_DIRS` performs path search even on command names with slashes in them.
			* `NO_CASE_GLOB` makes globbing case insensitive.
			* `NO_LIST_BEEP` doesn't beep on ambiguous completions.
add completion documentation 2015-12-15 02:07:30 -05:00
			`Contributing`
			`------------`

[completion] Add options to README.md Prefer `setopt NO_FOO` instead of `unsetopt FOO`, as former is easier to document in the README. Stick with the following style for the README: * Header 1 with the module name is in `lowercase`. * Other headers are in `Sentence case`. Common header names that should be consistently used are `Aliases`, `Contributing`, `Functions`, `Settings`, and `Zsh options`. 2018-12-15 16:54:32 -05:00			`Command completions should be submitted [upstream to zsh-completions][zsh-completions].`

			`[zsh-completions]: https://github.com/zsh-users/zsh-completions`