search

manodeep / Corrfunc

⚡️⚡️⚡️Blazing fast correlation functions on the CPU.
https://corrfunc.readthedocs.io
MIT License
166 stars 51 forks source link

Docs within C extensions need to be updated #80

Closed manodeep closed 8 years ago

manodeep commented 8 years ago

The docs within the extensions contain relevant info for the old API. All the extension functions need to be updated with the docs from the corresponding python wrapper.

The difference between the wrapper and the extension is that the extensions only accept string for a binfile (and not arrays, unlike the python wrappers). The return value always is a tuple with the results and time (unlike the python wrapper, which only returns a tuple if c_api_timer is set.

manodeep commented 8 years ago

Fixed via d17a2c766fda93a6398a1f9be6e9a9f3757a3ab2