* bug#19114: 25.0.50; doc string of `eval-expression-print-format' is inappropriate
@ 2014-11-20 2:50 Drew Adams
2016-04-30 15:13 ` Lars Ingebrigtsen
0 siblings, 1 reply; 8+ messages in thread
From: Drew Adams @ 2014-11-20 2:50 UTC (permalink / raw)
To: 19114
The doc string says "Return a formatted string which is displayed in the
echo area..." This is quite misleading. It can easily give the
impression that this function displays the returned value in the echo
area. THIS function does not with the formatted string, besides
returning it. It displays nothing. Please DTRT.
In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
of 2014-10-20 on LEG570
Bzr revision: 118168 rgm@gnu.org-20141020195941-icp42t8ttcnud09g
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
`configure --enable-checking=yes,glyphs CPPFLAGS=-DGLYPH_DEBUG=1'
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#19114: 25.0.50; doc string of `eval-expression-print-format' is inappropriate
2014-11-20 2:50 bug#19114: 25.0.50; doc string of `eval-expression-print-format' is inappropriate Drew Adams
@ 2016-04-30 15:13 ` Lars Ingebrigtsen
2016-04-30 15:27 ` Michael Heerdegen
` (2 more replies)
0 siblings, 3 replies; 8+ messages in thread
From: Lars Ingebrigtsen @ 2016-04-30 15:13 UTC (permalink / raw)
To: Drew Adams; +Cc: 19114
Drew Adams <drew.adams@oracle.com> writes:
> The doc string says "Return a formatted string which is displayed in the
> echo area..." This is quite misleading. It can easily give the
> impression that this function displays the returned value in the echo
> area. THIS function does not with the formatted string, besides
> returning it. It displays nothing. Please DTRT.
(defun eval-expression-print-format (value)
"Format VALUE as a result of evaluated expression.
Return a formatted string which is displayed in the echo area
in addition to the value printed by prin1 in functions which
display the result of expression evaluation."
I don't know quite what they're trying to express here...
But then again, I don't understand the meaning of the function, either:
(if (and (integerp value)
(or (eq standard-output t)
(zerop (prefix-numeric-value current-prefix-arg))))
(let ((char-string
(if (and (characterp value)
(char-displayable-p value))
(prin1-char value))))
(if char-string
(format " (#o%o, #x%x, %s)" value value char-string)
(format " (#o%o, #x%x)" value value)))))
(eval-expression-print-format 1)
C-x C-e
" (#o1, #x1, ?\\C-a)" appears in *Messages*
(eval-expression-print-format 1)
C-u C-x C-e
=> nil
Nothing in *Messages*
(eval-expression-print-format 'foo)
nil
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 8+ messages in thread* bug#19114: 25.0.50; doc string of `eval-expression-print-format' is inappropriate
2016-04-30 15:13 ` Lars Ingebrigtsen
@ 2016-04-30 15:27 ` Michael Heerdegen
2016-04-30 15:33 ` Lars Ingebrigtsen
2016-04-30 15:39 ` Lars Ingebrigtsen
2016-04-30 15:43 ` Eli Zaretskii
2 siblings, 1 reply; 8+ messages in thread
From: Michael Heerdegen @ 2016-04-30 15:27 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: 19114
Lars Ingebrigtsen <larsi@gnus.org> writes:
> I don't know quite what they're trying to express here...
Seems this function does only return a non-nil value for integer
values. It seems to be responsible for printing it in octal, hex, and
as a character.
> (eval-expression-print-format 1)
> C-x C-e
> " (#o1, #x1, ?\\C-a)" appears in *Messages*
C-x C-e prints the return value. The function doesn't print by itself
(AFAIU this is what Drew wanted to be made clearer).
> (eval-expression-print-format 1)
> C-u C-x C-e
> => nil
> Nothing in *Messages*
Expected, I think.
> (eval-expression-print-format 'foo)
> nil
Because foo is not an integer.
Michael.
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#19114: 25.0.50; doc string of `eval-expression-print-format' is inappropriate
2016-04-30 15:27 ` Michael Heerdegen
@ 2016-04-30 15:33 ` Lars Ingebrigtsen
2016-05-08 22:50 ` Michael Heerdegen
0 siblings, 1 reply; 8+ messages in thread
From: Lars Ingebrigtsen @ 2016-04-30 15:33 UTC (permalink / raw)
To: Michael Heerdegen; +Cc: 19114
Michael Heerdegen <michael_heerdegen@web.de> writes:
> Lars Ingebrigtsen <larsi@gnus.org> writes:
>
>> I don't know quite what they're trying to express here...
>
> Seems this function does only return a non-nil value for integer
> values. It seems to be responsible for printing it in octal, hex, and
> as a character.
Yes. Its name and its doc string seems to suggest that it's doing
something general, but it's doing something very particular: Formatting
an "extended integer" explanation in some circumstances.
I'll rewrite the doc string to say that it's doing that.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#19114: 25.0.50; doc string of `eval-expression-print-format' is inappropriate
2016-04-30 15:33 ` Lars Ingebrigtsen
@ 2016-05-08 22:50 ` Michael Heerdegen
0 siblings, 0 replies; 8+ messages in thread
From: Michael Heerdegen @ 2016-05-08 22:50 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: 19114
Lars Ingebrigtsen <larsi@gnus.org> writes:
> I'll rewrite the doc string to say that it's doing that.
Thank you for caring.
One thing: You wrote
This function is used by functions like `prin1' that display the
result of expression evaluation.
I don't know much about the C internals, so I could be wrong - but I
don't think this is true: I think `prin1' doesn't call
`eval-expression-print-format'. The command `eval-expression' does,
however, to give a nicer feedback.
Thanks,
Michael.
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#19114: 25.0.50; doc string of `eval-expression-print-format' is inappropriate
2016-04-30 15:13 ` Lars Ingebrigtsen
2016-04-30 15:27 ` Michael Heerdegen
@ 2016-04-30 15:39 ` Lars Ingebrigtsen
2016-04-30 15:43 ` Eli Zaretskii
2 siblings, 0 replies; 8+ messages in thread
From: Lars Ingebrigtsen @ 2016-04-30 15:39 UTC (permalink / raw)
To: Drew Adams; +Cc: 19114
Lars Ingebrigtsen <larsi@gnus.org> writes:
> (defun eval-expression-print-format (value)
> "Format VALUE as a result of evaluated expression.
> Return a formatted string which is displayed in the echo area
> in addition to the value printed by prin1 in functions which
> display the result of expression evaluation."
>
> I don't know quite what they're trying to express here...
Oh, I understood while rewriting. :-) It means that this function is
used by functions like `prin1' which typically display something in the
echo area.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#19114: 25.0.50; doc string of `eval-expression-print-format' is inappropriate
2016-04-30 15:13 ` Lars Ingebrigtsen
2016-04-30 15:27 ` Michael Heerdegen
2016-04-30 15:39 ` Lars Ingebrigtsen
@ 2016-04-30 15:43 ` Eli Zaretskii
2016-04-30 15:47 ` Lars Ingebrigtsen
2 siblings, 1 reply; 8+ messages in thread
From: Eli Zaretskii @ 2016-04-30 15:43 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: 19114
> From: Lars Ingebrigtsen <larsi@gnus.org>
> Date: Sat, 30 Apr 2016 17:13:45 +0200
> Cc: 19114@debbugs.gnu.org
>
> Drew Adams <drew.adams@oracle.com> writes:
>
> > The doc string says "Return a formatted string which is displayed in the
> > echo area..." This is quite misleading. It can easily give the
> > impression that this function displays the returned value in the echo
> > area. THIS function does not with the formatted string, besides
> > returning it. It displays nothing. Please DTRT.
>
> (defun eval-expression-print-format (value)
> "Format VALUE as a result of evaluated expression.
> Return a formatted string which is displayed in the echo area
> in addition to the value printed by prin1 in functions which
> display the result of expression evaluation."
>
> I don't know quite what they're trying to express here...
Much ado about nothing, if you ask me. Replace "is displayed" with
"will be displayed", and I think the intent is more clear.
> But then again, I don't understand the meaning of the function, either:
>
> (if (and (integerp value)
> (or (eq standard-output t)
> (zerop (prefix-numeric-value current-prefix-arg))))
> (let ((char-string
> (if (and (characterp value)
> (char-displayable-p value))
> (prin1-char value))))
> (if char-string
> (format " (#o%o, #x%x, %s)" value value char-string)
> (format " (#o%o, #x%x)" value value)))))
>
> (eval-expression-print-format 1)
> C-x C-e
> " (#o1, #x1, ?\\C-a)" appears in *Messages*
>
> (eval-expression-print-format 1)
> C-u C-x C-e
> => nil
> Nothing in *Messages*
Try "C-u 0", like the code says.
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2016-05-08 22:50 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-11-20 2:50 bug#19114: 25.0.50; doc string of `eval-expression-print-format' is inappropriate Drew Adams
2016-04-30 15:13 ` Lars Ingebrigtsen
2016-04-30 15:27 ` Michael Heerdegen
2016-04-30 15:33 ` Lars Ingebrigtsen
2016-05-08 22:50 ` Michael Heerdegen
2016-04-30 15:39 ` Lars Ingebrigtsen
2016-04-30 15:43 ` Eli Zaretskii
2016-04-30 15:47 ` Lars Ingebrigtsen
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).