[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#63861: [PATCH] pp.el: New "pretty printing" code
From: |
Eli Zaretskii |
Subject: |
bug#63861: [PATCH] pp.el: New "pretty printing" code |
Date: |
Sat, 17 Jun 2023 19:42:44 +0300 |
> From: Stefan Monnier <monnier@iro.umontreal.ca>
> Cc: 63861@debbugs.gnu.org
> Date: Sat, 17 Jun 2023 12:13:54 -0400
>
> >> +@defun pp object-or-beg &optional stream-or-end
> >> +This function indents and fills the printed representation of an
> >> +object (typically representing ELisp code) to make it more readable
> >> +for humans.
> >> +
> >> +It accepts two calling conventions: if called with two integers
> >> +@var{beg} and @var{end}, it indents and fills the corresponding
> >> +region, presumably containing the printed representation of one or
> >> +more objects, otherwise it takes a @var{object} and an optional
> >> +@var{stream}, and prints @var{object} like @code{prin1}, but does it
> >> +in a prettier way.
> >
> > This text references arguments like @var{object} that are named
> > differently in the @defun line.
>
> Indeed. Assuming you understood what I meant to say, do you have
> a recommendation of how to write it?
Something like this:
The function can be called to pretty-print either a region of text,
presumably containing the printed representation of one or more
objects, or to pretty-print an object. In the first case, the
function must be called with 2 arguments, @var{object-or-beg} and
@var{stream-or-end}, which are integer buffer positions that define
the region; in the second case, @var{object-or-beg} is the object to
print and @var{stream-or-end} is the stream to which to print it,
which defaults to @code{standard-output} if nil or omitted.
> Or maybe, I should leave `pp` alone and add a new `pp-region`
> function instead instead of combining two different calling conventions
> on a single function?
That might be better, indeed, both for documentation and for usage.
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/02
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Eli Zaretskii, 2023/06/03
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/03
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Eli Zaretskii, 2023/06/03
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/12
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Eli Zaretskii, 2023/06/13
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/16
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Eli Zaretskii, 2023/06/17
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/17
- bug#63861: [PATCH] pp.el: New "pretty printing" code,
Eli Zaretskii <=
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/17
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Visuwesh, 2023/06/03
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/07
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Visuwesh, 2023/06/08
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/09
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Ihor Radchenko, 2023/06/09
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Stefan Monnier, 2023/06/09
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Visuwesh, 2023/06/09
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Visuwesh, 2023/06/09
- bug#63861: [PATCH] pp.el: New "pretty printing" code, Juri Linkov, 2023/06/05