[m-rev.] for review: dump terms as docs in mdb

[Peter Wang]

On Thu, 25 Aug 2022 11:24:14 +1000 "Zoltan Somogyi" <zoltan.somogyi at runbox.com> wrote:
> 
> 2022-08-25 11:13 GMT+10:00 "Peter Wang" <novalazy at gmail.com>:
> >> Allow terms to be dumped as docs in mdb.
> >> 
> > 
> > I'm confused by this, as "docs" is not a data format. This functionality
> > should just be called pretty printing, and the dump command should take
> > a -p argument.
> 
> I have no objection to renaming the option, but among "dump", "dump -x"
> and "dump -d/p", the outlier is "dump -x", not "dump -d/p". -x writes out
> XML; the others both write out terms in Mercury syntax, though without
> any escapes of special chars, because that would hurt more than it would help.

My only objection is how the functionality is described.

> 
> >> +* The `dump` command has a new option: `dump -d Var` will dump the value
> >> +  of the given variable using the `write_as_doc` predicate in the
> >> +  pretty_printer module of the standard library.
> >> +
> > 
> > Say dump now supports pretty printing, without mentioning the
> > implementation method.
> 
> How about "... given variable in a pretty-printed form"?

That's fine.

Peter