From 2451239713e64f7272c8aadbdd15685e1b23355b Mon Sep 17 00:00:00 2001 From: Indrajit Raychaudhuri Date: Sat, 3 Jul 2021 12:26:46 -0500 Subject: [PATCH] general: Clarify relative ordering of modules in docs --- modules/autosuggestions/README.md | 8 ++++---- modules/history-substring-search/README.md | 12 ++++++++++-- modules/syntax-highlighting/README.md | 20 +++++++++++++------- 3 files changed, 27 insertions(+), 13 deletions(-) diff --git a/modules/autosuggestions/README.md b/modules/autosuggestions/README.md index a3e86c2..8aedb31 100644 --- a/modules/autosuggestions/README.md +++ b/modules/autosuggestions/README.md @@ -8,12 +8,12 @@ history and completions. If this module is used in conjunction with the [_`syntax-highlighting`_][3] module, this module must be loaded _after_ the _`syntax-highlighting`_ module. -If this module is used in conjunction with the [_`history-substring-search`_][4] -module, this module must be loaded _after_ the _`history-substring-search`_ -module. +Additionally, if this module is used in conjunction with the +[_`history-substring-search`_][4] module, this module must be loaded _after_ the +_`history-substring-search`_ module as well. To elaborate, the relative order of loading the modules would be -_`autosuggestions`_, _`syntax-highlighting`_ and _`history-substring-search`_. +_`syntax-highlighting`_, _`history-substring-search`_ and _`autosuggestions`_. ## Contributors diff --git a/modules/history-substring-search/README.md b/modules/history-substring-search/README.md index 5e8eeb0..3a109c5 100644 --- a/modules/history-substring-search/README.md +++ b/modules/history-substring-search/README.md @@ -8,6 +8,13 @@ commands. If this module is used in conjunction with the [_`syntax-highlighting`_][3] module, this module must be loaded _after_ the _`syntax-highlighting`_ module. +Additionally, if this module is used in conjunction with the +[_`autosuggestions`_][4] module, this module must be loaded _before_ the +_`autosuggestions`_ module. + +To elaborate, the relative order of loading the modules would be +_`syntax-highlighting`_, _`history-substring-search`_ and _`autosuggestions`_. + ## Contributors New features and bug fixes should be submitted to the @@ -60,7 +67,7 @@ zstyle ':prezto:module:history-substring-search' globbing-flags '' ## Authors -_The authors of this module should be contacted via the [issue tracker][4]._ +_The authors of this module should be contacted via the [issue tracker][5]._ - [Suraj N. Kurapati](https://github.com/sunaku) - [Sorin Ionescu](https://github.com/sorin-ionescu) @@ -68,4 +75,5 @@ _The authors of this module should be contacted via the [issue tracker][4]._ [1]: https://github.com/zsh-users/zsh-history-substring-search [2]: https://fishshell.com [3]: ../syntax-highlighting#readme -[4]: https://github.com/sorin-ionescu/prezto/issues +[4]: ../autosuggestions#readme +[5]: https://github.com/sorin-ionescu/prezto/issues diff --git a/modules/syntax-highlighting/README.md b/modules/syntax-highlighting/README.md index 2f6ea52..3debb67 100644 --- a/modules/syntax-highlighting/README.md +++ b/modules/syntax-highlighting/README.md @@ -4,12 +4,17 @@ Integrates [zsh-syntax-highlighting][1] into Prezto. This module must be loaded _before_ the _`prompt`_ module. +If this module is used in conjunction with the [_`history-substring-search`_][2] +module, this module must be loaded _before_ the _`history-substring-search`_ +module. + Additionally, if this module is used in conjunction with the -[_`history-substring-search`_][2] module, this module must be loaded _before_ -the _`history-substring-search`_ module. +[_`autosuggestions`_][3] module, this module must be loaded _before_ the +_`autosuggestions`_ module as well. To elaborate, the relative order of loading the modules would be -_`syntax-highlighting`_, _`history-substring-search`_ and _`prompt`_. +_`syntax-highlighting`_, _`history-substring-search`_, _`autosuggestions`_ and +_`prompt`_. ## Contributors @@ -30,7 +35,7 @@ zstyle ':prezto:module:syntax-highlighting' color 'yes' ### Highlighters -Syntax highlighting is accomplished by pluggable [highlighters][3]. This module +Syntax highlighting is accomplished by pluggable [highlighters][4]. This module only enables the _main_ highlighter by default. To enable all highlighters, add the following to @@ -62,11 +67,12 @@ zstyle ':prezto:module:syntax-highlighting' styles \ ## Authors -_The authors of this module should be contacted via the [issue tracker][4]._ +_The authors of this module should be contacted via the [issue tracker][5]._ - [Sorin Ionescu](https://github.com/sorin-ionescu) [1]: https://github.com/zsh-users/zsh-syntax-highlighting [2]: ../history-substring-search#readme -[3]: https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters -[4]: https://github.com/sorin-ionescu/prezto/issues +[3]: ../autosuggestions#readme +[4]: https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters +[5]: https://github.com/sorin-ionescu/prezto/issues