[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Texinfo and error messages
From: |
Mike Miller |
Subject: |
Texinfo and error messages |
Date: |
Wed, 2 Oct 2019 16:36:09 -0700 |
User-agent: |
Mutt/1.10.1 (2018-07-13) |
Hi,
The topic of how to format error messages in Texinfo example blocks came
up in a separate discussion [1]. I looked into it, and found that
Texinfo has a @error macro for this purpose [2]. But I also found that
Octave doesn't use it, and instead uses @print, @result, or sometimes
nothing, in @example blocks in function docstrings and the user manual.
Should we use the @error macro? Or should we standardize on another
convention? Here are a few possible choices, in no particular order.
@print{} error: sqrt: argument must be numeric
@error{} error: sqrt: argument must be numeric
@error{} sqrt: argument must be numeric
Attached is a patch that applies the second choice above in a few
places. I actually prefer the third option, since the rendered output
"error→ error: ..." seems redundant. But maybe the first option is even
better for our purposes.
Thoughts?
[1]: https://github.com/catch22/octave-doctest/issues/238
[2]:
https://www.gnu.org/software/texinfo/manual/texinfo/html_node/_0040error.html
--
mike
texinfo-error.patch
Description: Text Data
signature.asc
Description: PGP signature
- Texinfo and error messages,
Mike Miller <=