unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#44451: 27.1; doc string of `read-char-from-minibuffer'
@ 2020-11-04 18:40 Drew Adams
  2020-11-05  6:33 ` Richard Stallman
  2020-11-07  9:12 ` Eli Zaretskii
  0 siblings, 2 replies; 3+ messages in thread
From: Drew Adams @ 2020-11-04 18:40 UTC (permalink / raw)
  To: 44451

 "Read a character from the minibuffer, prompting for PROMPT."

You are not prompted for PROMPT.  You are prompted (for a char)
with PROMPT.

 "When HISTORY is a symbol, then allows navigating in a history."

English: it should be "When...symbol, allow navigating..."

But it's not clear what "navigating in a history" means.  The
description of `M-n' etc. isn't clear - or needed.  And what if
HISTORY is non-nil but not a symbol?

In any case, I suggest you just say that HISTORY is passed to
`read-from-minibuffer', which is the case.  That function's HISTORY
description is clear and complete, and it involves more than what is
described here.


In GNU Emacs 27.1 (build 1, x86_64-w64-mingw32)
 of 2020-08-12 built on CIRROCUMULUS
Repository revision: 86d8d76aa36037184db0b2897c434cdaab1a9ae8
Repository branch: HEAD
Windowing system distributor 'Microsoft Corp.', version 10.0.18362
System Description: Microsoft Windows 10 Pro (v10.0.1903.18362.1082)





^ permalink raw reply	[flat|nested] 3+ messages in thread

* bug#44451: 27.1; doc string of `read-char-from-minibuffer'
  2020-11-04 18:40 bug#44451: 27.1; doc string of `read-char-from-minibuffer' Drew Adams
@ 2020-11-05  6:33 ` Richard Stallman
  2020-11-07  9:12 ` Eli Zaretskii
  1 sibling, 0 replies; 3+ messages in thread
From: Richard Stallman @ 2020-11-05  6:33 UTC (permalink / raw)
  To: Drew Adams; +Cc: 44451

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  >  "Read a character from the minibuffer, prompting for PROMPT."

  > You are not prompted for PROMPT.  You are prompted (for a char)
  > with PROMPT.

That is true, but there are kinder ways to make that point.  For
instance, `

    Actuallly, it prompts with PROMPT, not for RROMPT.

-- 
Dr Richard Stallman
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)







^ permalink raw reply	[flat|nested] 3+ messages in thread

* bug#44451: 27.1; doc string of `read-char-from-minibuffer'
  2020-11-04 18:40 bug#44451: 27.1; doc string of `read-char-from-minibuffer' Drew Adams
  2020-11-05  6:33 ` Richard Stallman
@ 2020-11-07  9:12 ` Eli Zaretskii
  1 sibling, 0 replies; 3+ messages in thread
From: Eli Zaretskii @ 2020-11-07  9:12 UTC (permalink / raw)
  To: Drew Adams; +Cc: 44451-done

> Date: Wed, 4 Nov 2020 10:40:01 -0800 (PST)
> From: Drew Adams <drew.adams@oracle.com>
> 
>  "Read a character from the minibuffer, prompting for PROMPT."
> 
> You are not prompted for PROMPT.  You are prompted (for a char)
> with PROMPT.

Fixed.

>  "When HISTORY is a symbol, then allows navigating in a history."
> 
> English: it should be "When...symbol, allow navigating..."

Fixed.

> But it's not clear what "navigating in a history" means.  The
> description of `M-n' etc. isn't clear - or needed.  And what if
> HISTORY is non-nil but not a symbol?

You get an error, I think.

> In any case, I suggest you just say that HISTORY is passed to
> `read-from-minibuffer', which is the case.

That isn't accurate: this function really expects HISTORY to be a
symbol of a history variable.





^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-11-07  9:12 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-11-04 18:40 bug#44451: 27.1; doc string of `read-char-from-minibuffer' Drew Adams
2020-11-05  6:33 ` Richard Stallman
2020-11-07  9:12 ` Eli Zaretskii

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).