search

JuliaMath / Yeppp.jl

Yeppp! bindings
Other
55 stars 14 forks source link

inline documentation #23

Closed abhijithch closed 8 years ago

abhijithch commented 8 years ago

Included inline documentation for some of the exposed functions.

ViralBShah commented 8 years ago

We need to tag a new release.

tkelman commented 8 years ago

Do we really need package documentation for methods that are exactly the same signatures as in base?

ViralBShah commented 8 years ago

Why not? Question is if it should just point to Base, but I suspect that this will have other notes that will have to come in from Yeppp.

tkelman commented 8 years ago

Because the base versions of these methods are probably documented more clearly? If these are following the same API that is not specific to yeppp in any way, there's nothing to be gained by putting these here. Yeppp specific documentation can be added of course, or anywhere the corresponding base docstring is missing it can be added there.

abhijithch commented 8 years ago

@tkelman we did'nt want to not have any helper functions for Yeppp. So what would the best way to point it to base where the APIs are the same?

tkelman commented 8 years ago

Ah sorry my mistake, I didn't realize that this module isn't extending anything from base, it has its own separate Yeppp.dot etc methods. This is fine for now then.