search

polsys / ennemi

Easy Nearest Neighbor Estimation of Mutual Information
https://polsys.github.io/ennemi/
MIT License
35 stars 12 forks source link

Add license header to each source file #47

Closed polsys closed 4 years ago

polsys commented 4 years ago

This is a good practice.

morrme commented 4 years ago

Do you want this on all of the /benchmarks/ files in addition to the /ennemi/ files?

polsys commented 4 years ago

Hi! I think it would be good to have the header in all of benchmarks, ennemi and tests plus setup.py. Maybe something like

# MIT License - Copyright Petri Laarne and contributors
# See the LICENSE.md file included in this source code package
morrme commented 4 years ago

So you do not want the full license header anywhere? Just a reference to the file?

polsys commented 4 years ago

Yes, I think it would be enough. As far as I understand, the MIT license does not require even the header, but it's considered a good practice. Having the full license text in every file would be distracting, I think. Please correct me if I'm wrong :)

morrme commented 4 years ago

correct; it is not required but nice to do. I've seen it formatted both ways, so what you've chosen is totally fine and I'm happy to help get it done :)