search

acroy / Expokit.jl

Julia implementation of EXPOKIT routines
Other
26 stars 11 forks source link

precompile and add module's docstring #17

Closed mforets closed 6 years ago

ChrisRackauckas commented 6 years ago

Doesn't the module docstring already default to the package README?

mforets commented 6 years ago

That's right,

julia> ?Expokit
No documentation found.

  Displaying the README.md for the module instead.
.....

I would move the explanation for expmv to a file in the docs/.. -- or to put all available functions in the README.

mforets commented 6 years ago

@acroy What about this? The module's docstring can be removed, as it was suggested, but can we add the __precompile__ flag? The reason is that julia sometimes complains if you want to precompile a module which depends on another one which is not precompiled.

ChrisRackauckas commented 6 years ago

This should be precompiled for sure.

acroy commented 6 years ago

I will just merge it as it is. The doc-string can later be removed or adjusted.