Meaning of \spadignore in database and "i.e."

[Grégory Vanuxem]

hello,

I use in a routine 'jlDocumentation' OperationsQuery:

ops := getDatabase("o")$OperationsQuery
req := elt(ops,equation('name, string op)$QueryEquation)
-- See alql.spad
docs : DataList(String) := elt(req,'doc)

To clean HyperTeX command/format I use the Julia regex engine. I
recently improved it with help of api.spad. I would be happy if you
can test this routine using the Julia addon to FriCAS available at
https://github.com/gvanuxem/jlfricas.

Since I do not know what (and why) the HyperTeX \spadignore command is,
I used this "regex replace":
"\\LaTeX" => "LaTeX: "
"\\spadignore" => _"Ignore: "
"\\space" => " "
etc.

But i encountered this with ".i.e." in a ++ documentation operation:
randtest(randtype) returns a random number depending on the Julia symbol rand
type. :urandom an uniformly distributed random number contained in [0,1]. To
test corner cases: :randtest returns a finite random number, :randtest_exact
returns a zero radius random number, :randtest_precise returns a precise rand
om number Ignore: i.e. with a radius of around 2^-precision() the magnitude o
f the midpoint, :randtest_special returns a special random number where midpo
int and/or radius might be NaNs or infinities, :randtest_wide returns a rando
m number with a large radius that might be big relative to its midpoint.

As you can see there is a "Ignore: " in the resulted string so it
seems that during the build of database files "i.e." is replaced by
\spadignore{i.e.}, any idea why and what is the purpose of it?

For information in HyperDoc "i.e." is correctly displayed, not ignored.

Regards,

- Greg

[Waldek Hebisch]

\spadignore means that its argument should _not_ be processed in
special way. In general, documentation strings are subject to
various transformations which sometimes produce undesired effects.
\spadignore protects its argument, so that later transformations
can not mangle it. Once HyperDoc processing is done \spadignore
is no longer needed (it just gives its argument).

--
Waldek Hebisch

[Grégory Vanuxem]

Oh, ok. That's clear to me now. I can safely remove it from my resulted string. Thanks Waldek. 

- Greg

--
You received this message because you are subscribed to the Google Groups "FriCAS - computer algebra system" group.
To unsubscribe from this group and stop receiving emails from it, send an email to fricas-devel...@googlegroups.com.
To view this discussion visit https://groups.google.com/d/msgid/fricas-devel/aQbZjlcgSY9QMuMj%40fricas.org.