On 30/03/17 23:25, Ralf Hemmecke wrote:
On 03/30/2017 10:59 PM, Peter Broadbery wrote:
Sorry - somewhat unclear.. The plugin is fairly good for spad files and shows ++
comments for domains, without any pre-processing.. In the java world the
corresponding /** comments are turned into html with a bit more markup. This
could potentially happen for spad, would "just" be a question of being able to
generate the appropriate markup and link to it. As I understand it, the api
docs on the .io site contain the right html.
This may be irrelevant or off topic but, since you mention ++ comments
and fricas.github.io, I have some views on the content if not the markup.
In my recent attempts to understand permgrps.spad I have thought about
what meta information would be useful to someone new to the code, both
user or developer.
One of the most important things for me, in understanding a function, is
information about the parameters and return value of a function. If I am
very clear about the inputs and outputs I can often work out the bits
in-between. This information can be coded in the /** comments of java so
I guess the java language designers agree with me on this issue.
Another thing I would really like is links (coded as URLs) to other
sources of information about a given domain, function, etc. In FriCAS
there are so many potential places where
documentation/tutorial/explanation may, or may not be, found. It is a
time consuming process just to find out if there is any information
known. Even if (as often happens) the only explanation is a post from
Waldek then I think there should be a link to it.
Another thing I would like coded in ++ comments and picked up by .io is
local in addition to exported metadata. I suspect this would be harder
to do and get away from the original intention. However I would like to
be able to drill down to information about Rep and local functions.
Sorry if this is off-topic but if there is any chance of some of this
happening then its worth mentioning it.
Martin B
--
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 [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/fricas-devel.
For more options, visit https://groups.google.com/d/optout.
