search

manodeep / Corrfunc

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

Misleading docs about binning #123

Closed manodeep closed 6 years ago

manodeep commented 7 years ago

The docs (http://corrfunc.readthedocs.io/en/master/modules/generate_bins.html) state that completely arbitrary bins can be specified - this is not true. Binning strategy can be arbitrary but as of now, bins have to be continuous.

Might be worth improving in the future - but probably only if requested by users. There improvement will need to touch all kernels in all statistics code (but should not change the function interfaces)

manodeep commented 7 years ago

As I am looking through the docstrings, I see remnants of #96 embedded within the inline docs. Needs to be fixed before this issue is closed.

manodeep commented 6 years ago

Given my last comment, I will leave this issue open.

manodeep commented 6 years ago

grepping through the entire repo did not produce any matches for the wrong 15 bins claim. Closing