search

anazalea / pySankey

create sankey diagrams with matplotlib
GNU General Public License v3.0
249 stars 95 forks source link

Some style and clarity changes #9

Closed Pierre-Sassoulas closed 6 years ago

Pierre-Sassoulas commented 6 years ago

Regarding the pylint configuration file : Pep8 recommend using snake_case and everything was in camelCase. I created a "figure_name" attribute previousely, but this is not folloying the convention used everywhere else. in pysankey. Changing everything to snake_case would probably cause a lot of backward compatibilty issues, so I changed pylint configuration to take the legacy into account. We should probably change the "figure_name" attribute to "figureName" so we're using the same convention everywhere.

Pierre-Sassoulas commented 6 years ago

I did not see you added a setup.py yourself already :) So this PR is almost only style change now.

Except : I removed the dist/build dir it made git goes crazy and makes rebase hard (There was two sankey.py). I also modified the licence in setup.py (It seems you use agplv3 and not MIT ?)

Pierre-Sassoulas commented 6 years ago

I rewrote some of the commits in order to make them clearer, I hope you did not get spammed to much. Sankey is imported differently and the "figure_name" parameter changed to "figureName", so it breaks compatibility with old code. I think it's reasonable to do that because the switch to pip already breaks old code. I modified the Readme accordingly and changed the version to 1.0.0.