On 11/5/24 08:12, Grégory Vanuxem wrote:
Try:
fricas -noht
compile the attached file and via the system command synonym )hd
browse for 'bar', you will see in boldface clickable examples.
OK, that might be nice, but I am not interested in that. I am rather for
removing HyperDoc altogether. So I'd rather like to see more ways that
use current technology to browse the documentation.
In fact, I consider ++ docstrings as not the right place for examples.
Note, that they basically describe functions in the Category. For
examples, however, one would have to be more concrete, i.e. choosing
concrete values for the parameters. Also note that the documentation of
a function like foo for DomainA, documents also foo from DomainB if we
have something like
Foo(X: Type): Category == with
foo: (x, x) -> X
DomainA(X: Type): Foo(X) == ...
DomainB(X: Type, Y: Type): Foo(X) == ...
The specification for foo might be easy, but for the examples, you
cannot easily do them, because DomainA and/or DomainB have to be
compiled in order to execute the examples for foo.
I would actually go another way, namely providing notebooks for jfricas
and showing them like here:
https://fricas.github.io/fricas-notebooks/index.html
As you see, a user can also download that notebook from Github.
We simply need more people that write "executable" notebooks and commit
to keeping them up-to-date with new versions of FriCAS.
Ralf
--
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+unsubscr...@googlegroups.com.
To view this discussion visit
https://groups.google.com/d/msgid/fricas-devel/c03363dc-c4cf-4cd9-b08d-805543941962%40hemmecke.org.
