Texinfo template file with deffn item for each padics function

[robert-dodier]

Hi, I've created a Texinfo file which I think can be a good place to start writing documentation for padics. For each function in padics, I generated a skeleton of the Texinfo stuff for it. Since there are a lot of functions, it seems like this could help save some time.

To be specific, after loading padics.mac, I executed for f in functions do emitfn(f) where emitfn is defined as follows:

emitfn(f) :=
 (printf (true, "@deffn {Function} ~a (~{@var{~a}~^, ~})~%~%", op(f), args(f)),
  printf (true, "Computes FOO for ~{@var{~a}~^, ~}.~%~%", args(f)),
  printf (true, "@code{load(\"padics.mac\")} loads this function.~%~%"),
  printf (true, "Example:~%~%@c ===beg===~%@c load(\"padics.mac\");~%@c ~a~%@c ===end===~%~%", f),
  printf (true, "@end deffn~%~%"));

I pasted the resulting output into a Texinfo file and I've attached it to this issue as padics.txt, but it is really padics.texi (I had to change the name to make it acceptable to Github). I hope this is helpful to you for creating documentation for each padics function.

padics.txt

[josanvallejo]

Thanks! Working on it, right now...