GNU bug report logs - #40695
[PATCH] ; Fix some typos and doc issues

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Štěpán Němec <stepnem <at> gmail.com>
Cc: 40695 <at> debbugs.gnu.org
Subject: bug#40695: [PATCH] ; Fix some typos and doc issues
Date: Sat, 18 Apr 2020 15:28:14 +0300

> From: Štěpán Němec
>  <stepnem <at> gmail.com>
> Date: Sat, 18 Apr 2020 13:37:35 +0200
> 
> ---
> [Rebased on top of current emacs-27]

Thanks.  A few comments below.

> --- a/doc/emacs/fixit.texi
> +++ b/doc/emacs/fixit.texi
> @@ -201,8 +201,8 @@ Transpose
>    A numeric argument to a transpose command serves as a repeat count: it
>  tells the transpose command to move the character (or word or
>  expression or line) before or containing point across several other
> -characters (or words or expressions or lines).  For example, @kbd{C-u
> -3 C-t} moves the character before point forward across three other
> +characters (or words or expressions or lines).  For example, @w{@kbd{C-u
> +3 C-t}} moves the character before point forward across three other

Are all of the places where you inserted @w{..} split expressions or
commands between lines?  I don't want to have redundant @w{..} in the
manual sources.

> -@strong{Warning:} if the changes you combine occur in widely scattered
> +@strong{Warning:} If the changes you combine occur in widely scattered

Not sure the original text is a typo.

> diff --git a/doc/misc/texinfo.tex b/doc/misc/texinfo.tex
> index 6d9d7113f7..1d05eab65c 100644
> --- a/doc/misc/texinfo.tex
> +++ b/doc/misc/texinfo.tex

texinfo.tex is not maintained by us, it is an imported file.  Please
report this to the Texinfo mailing list.

> --- a/lisp/emacs-lisp/cl-macs.el
> +++ b/lisp/emacs-lisp/cl-macs.el
> @@ -776,7 +776,7 @@ cl-case
>    "Eval EXPR and choose among clauses on that value.
>  Each clause looks like (KEYLIST BODY...).  EXPR is evaluated and
>  compared against each key in each KEYLIST; the corresponding BODY
> -is evaluated.  If no clause succeeds, cl-case returns nil.  A
> +is evaluated.  If no clause succeeds, `cl-case' returns nil.  A

I'd prefer to say "this macro" here.  It doesn't seem useful to have a
link to the macro from its own doc string.

>  (defmacro cl-typecase (expr &rest clauses)
> -  "Evals EXPR, chooses among clauses on that value.
> +  "Eval EXPR and choose among clauses on that value.
>  Each clause looks like (TYPE BODY...).  EXPR is evaluated and, if it
>  satisfies TYPE, the corresponding BODY is evaluated.  If no clause succeeds,
> -cl-typecase returns nil.  A TYPE of t or `otherwise' is allowed only in the
> +`cl-typecase' returns nil.  A TYPE of t or `otherwise' is allowed only in the

Likewise here.

> -;; `iter-do' is like `cl-do', except that instead of walking a list,
> +;; `iter-do' is like `dolist', except that instead of walking a list,

Is the original text in error here?

>  (defvar cps--dynamic-wrappers '(identity)
> -  "List of transformer functions to apply to atomic forms we
> -evaluate in CPS context.")
> +  "\
> +List of transformer functions applied to atomic forms evaluated in CPS context."
> +  )

This should be fixed by making the sentence shorter.  The sentence is
a mouthful, IMO.

>  (defun cps--atomic-p (form)
> -  "Return whether the given form never yields."
> -
> +  "Return non-nil if FORM never yields."

Why this change?

> -like `try-completion'; if it's t, this function works like
> -`all-completion'; and any other values makes it work like
> +like `try-completion'; if it is t, this function works like
> +`all-completion'; and any other value makes it work like

What was wrong here?

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.