branch: master commit 2905d17fae550adf20489d1166e4690b73464b62 Author: Oleh Krehel <ohwoeo...@gmail.com> Commit: Oleh Krehel <ohwoeo...@gmail.com>
doc/ivy.org: fix typos --- doc/ivy.org | 10 +++++----- doc/ivy.texi | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/ivy.org b/doc/ivy.org index d74ff5c..d8b397a 100644 --- a/doc/ivy.org +++ b/doc/ivy.org @@ -1041,9 +1041,9 @@ equivalents in =ivy-mode= are: :PROPERTIES: :CUSTOM_ID: api :END: -The main (and only) entry point is =ivy-read= function. It takes two -required arguments and many optional arguments that can be passed by -key. The optional =:action= argument is highly recommended for +The main (and only) entry point is the =ivy-read= function. It takes +two required arguments and many optional arguments that can be passed +by a key. The optional =:action= argument is highly recommended for features such as multi-actions, non-exiting actions, =ivy-occur= and =ivy-resume=. @@ -1132,8 +1132,8 @@ features such as multi-actions, non-exiting actions, =ivy-occur= and :CUSTOM_ID: example---counsel-describe-function :END: This is a typical example of a function with a non-async collection, -which is a collection where the strings in the collection are known -prior to any input from the user. +which is a collection where all the strings in the collection are +known prior to any input from the user. Only the first two arguments (along with =action=) are essential - the rest of the arguments are for fine-tuning, and could be omitted. diff --git a/doc/ivy.texi b/doc/ivy.texi index c88257b..24a0c5b 100644 --- a/doc/ivy.texi +++ b/doc/ivy.texi @@ -1371,9 +1371,9 @@ sessions. @node API @chapter API -The main (and only) entry point is @code{ivy-read} function. It takes two -required arguments and many optional arguments that can be passed by -key. The optional @code{:action} argument is highly recommended for +The main (and only) entry point is the @code{ivy-read} function. It takes +two required arguments and many optional arguments that can be passed +by a key. The optional @code{:action} argument is highly recommended for features such as multi-actions, non-exiting actions, @code{ivy-occur} and @code{ivy-resume}. @menu @@ -1497,8 +1497,8 @@ Is a symbol that uniquely identifies the function that called @section Example - @code{counsel-describe-function} This is a typical example of a function with a non-async collection, -which is a collection where the strings in the collection are known -prior to any input from the user. +which is a collection where all the strings in the collection are +known prior to any input from the user. Only the first two arguments (along with @code{action}) are essential - the rest of the arguments are for fine-tuning, and could be omitted.