[m-rev.] for review: address github issue #37

Mark Brown mark at mercurylang.org
Tue Oct 27 00:52:23 AEDT 2015


On Thu, Oct 22, 2015 at 10:53 AM, Zoltan Somogyi
<zoltan.somogyi at runbox.com> wrote:
> This addresses the issue, in that it shows that the "size" command
> is supposed to be issued in the context of a question from the
> declarative debugger, not at the "mdb> " prompt.
>
> However, I am not sure about two things. One is simply:
> is showing the prompt a good way to get across the idea that
> each command is usable only in a given context, or do not need
> something more verbose? The second is related: it uses "Valid?"
> as the prompt in the documentation to show a question from
> the declarative debugger, because it is by far the most common
> question, but there are others as well, such as "Satisfyable?",
> after which the declarative debugger accepts the same set of
> commands. We could replace "Valid?" in the documentation
> of such commands by e.g. "{Valid?, Satisfyable?,...}", or by e.g.
> "[declarative debugger question such as Valid?]".
>
> Any thoughts?

I think you need something more verbose than just the prompt. The help
message could say "This is a declarative debugging command" at the
start or at the end of the text, for example.

Alternatively, the term browser and declarative debugger could use the
format_param command instead of using the older forms, or mdb could
allow the older forms as shorthand. This would avoid the need for the
documentation (or the user) to make a distinction.

Cheers,
Mark.



More information about the reviews mailing list