bug#34504: 'pp' causally mentioned

bug#34504: 'pp' causally mentioned

[積丹尼 Dan Jacobson]

In (info "(emacs) Program Indent") it says:
   Emacs also provides a Lisp pretty-printer in the ‘pp’ package, which
reformats Lisp objects with nice-looking indentation."

OK, as there is no hyperlink to click on, say the user eventually finds
that indeed there is
$ dlocate /pp\\.
emacs-el: /usr/share/emacs/26.1/lisp/emacs-lisp/pp.el.gz
and loads it, but he still cannot use it because there is no further
example of how, provided, even within that file. E.g., you could mention
how to pretty print one's .emacs with it.

bug#34504: 'pp' causally mentioned

[Eli Zaretskii]

tags 34504 notabug
thanks

> From: 積丹尼 Dan Jacobson
> 	<jidanni@jidanni.org>
> Date: Sun, 17 Feb 2019 03:33:50 +0800
> 
> In (info "(emacs) Program Indent") it says:
>    Emacs also provides a Lisp pretty-printer in the ‘pp’ package, which
> reformats Lisp objects with nice-looking indentation."
> 
> OK, as there is no hyperlink to click on

In my version of the manual, that sentence is followed by a hyperlink:

     Emacs also provides a Lisp pretty-printer in the ‘pp’ package, which
  reformats Lisp objects with nice-looking indentation.  *Note pp:
  (elisp)Output Functions.

> say the user eventually finds
> that indeed there is
> $ dlocate /pp\\.
> emacs-el: /usr/share/emacs/26.1/lisp/emacs-lisp/pp.el.gz
> and loads it, but he still cannot use it because there is no further
> example of how, provided, even within that file. E.g., you could mention
> how to pretty print one's .emacs with it.

pp doesn't by itself pretty-print files, it can only pretty-print Lisp
objects (as the hyperlinked node of the ELisp manual describes).

bug#34504: 'pp' causally mentioned

[積丹尼 Dan Jacobson]

OK it can only do objects, not a collection of objects, which is what I
suppose a file is. So how to pretty print one's .emacs file with it
might be mentioned as an exercise for the reader on that page.

bug#34504: 'pp' causally mentioned

[Michael Heerdegen]

積丹尼 Dan Jacobson <jidanni@jidanni.org> writes:

> OK it can only do objects, not a collection of objects, which is what
> I suppose a file is. So how to pretty print one's .emacs file with it
> might be mentioned as an exercise for the reader on that page.

There's `pp-buffer'.  It's only a function, however.

Note that AFAIK, pp is nothing more as a very thin wrapper around the
standard Elisp printer that adds some additional line breaks, and even
that in a not very intelligent way.  A good pretty printer you could use
to prettify your .emacs still has to be written.


Michael.

bug#34504: 'pp' causally mentioned

[積丹尼 Dan Jacobson]

MH> There's `pp-buffer'.  It's only a function, however.
OK maybe tell the user to
M-: (pp-buffer)    [eval-expression]
C-x h              [mark-whole-buffer]
<tab>              [indent-for-tab-command]
Now one's lisp looks pretty good.

bug#34504: 'pp' causally mentioned

[Eli Zaretskii]

> From: 積丹尼 Dan Jacobson <jidanni@jidanni.org>
> Cc: 34504@debbugs.gnu.org
> Date: Sun, 17 Feb 2019 23:37:29 +0800
> 
> OK it can only do objects, not a collection of objects, which is what I
> suppose a file is.

No, a file is not a collection of objects, not unless you eval it.

> So how to pretty print one's .emacs file with it
> might be mentioned as an exercise for the reader on that page.

I don't think 'pp' is something that would support such an exercise.
IOW, I think you are looking for a feature in the wrong place.

bug#34504: 'pp' causally mentioned

[Michael Heerdegen]

積丹尼 Dan Jacobson <jidanni@jidanni.org> writes:

> MH> There's `pp-buffer'.  It's only a function, however.
> OK maybe tell the user to
> M-: (pp-buffer)    [eval-expression]
> C-x h              [mark-whole-buffer]
> <tab>              [indent-for-tab-command]
> Now one's lisp looks pretty good.

In some cases it looks prettier, but in others it looks uglier.  For
example

#+begin_src emacs-lisp
(let ((x 1) (y 2))
  (+ x y))

(defun f (n) (1+ n))
#+end_src

becomes

#+begin_src emacs-lisp
(let
    ((x 1)
     (y 2))
  (+ x y))
(defun f
    (n)
  (1+ n))
#+end_src

after your treatment.  Too many added line breaks for my gusto, but OTOH
the empty line between the two expressions has disappeared.

pp may be ok for improving how an evaluation result is presented to the
user, but it's IMHO by far not suitable for reformatting hand-written
code.


Michael.

bug#34504: 'pp' causally mentioned

[積丹尼 Dan Jacobson]

(Well it helped for .newsrc.eld files.)

bug#34504: 'pp' causally mentioned

[Stefan Kangas]

Eli Zaretskii <eliz@gnu.org> writes:

> tags 34504 notabug
> thanks
>
>> From: 積丹尼 Dan Jacobson
>>     <jidanni@jidanni.org>
>> Date: Sun, 17 Feb 2019 03:33:50 +0800
>>
>> In (info "(emacs) Program Indent") it says:
>>    Emacs also provides a Lisp pretty-printer in the ‘pp’ package, which
>> reformats Lisp objects with nice-looking indentation."
>>
>> OK, as there is no hyperlink to click on
>
> In my version of the manual, that sentence is followed by a hyperlink:
>
>      Emacs also provides a Lisp pretty-printer in the ‘pp’ package, which
>   reformats Lisp objects with nice-looking indentation.  *Note pp:
>   (elisp)Output Functions.
>
>> say the user eventually finds
>> that indeed there is
>> $ dlocate /pp\\.
>> emacs-el: /usr/share/emacs/26.1/lisp/emacs-lisp/pp.el.gz
>> and loads it, but he still cannot use it because there is no further
>> example of how, provided, even within that file. E.g., you could mention
>> how to pretty print one's .emacs with it.
>
> pp doesn't by itself pretty-print files, it can only pretty-print Lisp
> objects (as the hyperlinked node of the ELisp manual describes).

Already marked notabug, and from reading the discussion it doesn't look
like there's more to do here.  I'm therefore closing this bug.

Best regards,
Stefan Kangas