SpecialFunctions.jl
SpecialFunctions.jl copied to clipboard
JuliaMath
Documentation
The documentation of this package leaves a lot to be desired. Some ideas:
- Split it up into obvious sections (perhaps along the lines of the DLMF)
- Document the domains/where the function is defined
- Add external links (Wikipedia and DLMF are the obvious ones to link to).
- References to implementations
- Add plots
- handle discontinuities nicely
- nice plotting of complex functions (see https://reference.wolfram.com/language/ref/ComplexPlot3D.html for some ideas)
I'll do some of this work this weekend if not earlier. Also where should these changes be done? The domains and ext. links can be done in the function docstring where they are defined. What about plots?
I don't think it is possible to have docs in docstrings, they would have to go into the markdown files. I have some code I'll post.
I'd like to help out here. Have you got any special layout in mind? I'd just create sections along DLMF and then a subsection for each function (sorted alphabetically). Each function would be described in the same manner: domain+links(wikipedia/DLMF)+plots [optinally: implementation details+todos].
What are thoughts on it?
@PaulXiCao That would be fantastic. I would encourage you to start with small incremental changes and we can go from there.
@simonbyrne I just uploaded the first two documentations about erf, and erfc. I'd be happy for some more input.
My thoughts this far:
- Section names according to DLMF but no further subsectioning except one for each function. For me this seems enough at first .
- I didnt add any more explanations or plots bc i think nobody really cares. Doesnt just everybody go to wikipedia for further informations?
- What do you think about the layout? Very basic but is it enough or did you have something fancier in mind?