search

rleonid / oml

OCaml Math Library
Apache License 2.0
119 stars 9 forks source link

repetition in the documentation of the API #187

Closed vd1 closed 7 years ago

vd1 commented 7 years ago

here: http://www.hammerlab.org/oml/Uncategorized.Functions.html there is a repetition in the text:

Implementations of special functions such as those needed to compute probability distributions.

At the present moment many functions are wrappers to the Cephes library (http://www.netlib.org/cephes/), via a Ctypes interface implemented in the Ocephes library.

Implementations of special functions such as those needed to compute probability distributions.

At the present moment many functions are wrappers to the Cephes library (http://www.netlib.org/cephes/), via a Ctypes interface implemented in the Ocephes library.

rleonid commented 7 years ago

Thank you for bringing this to my attention. Since this error seems to stem from a vagary of ocamldoc and my own custom hacking to setup the mli for input, I'll try to and make sure that it is resolved when I release and update the docs for 0.0.7.

vd1 commented 7 years ago

+1

rleonid commented 7 years ago

@vd1 The latest documentation for Functions in Oml_full unfortunately still has a duplication. In order to create decent documentation, I'm unfortunately forced to munge the contents of mli files inside of each other as at the moment there isn't a way to tell ocamldoc to grab the documentation from an included module or module type. The duplicate comment comes from the oml_functions that is included inside of omlf_functions. Without sacrificing the comment there or special casing some smarter/hack I'd prefer to leave it there.