search

MBravoS / splotch

Simple PLOTs, Contours and Histograms is a small package with wrapper functions designed to simplify plotting calls from matplotlib.
BSD 3-Clause "New" or "Revised" License
5 stars 0 forks source link

Update of the README #74

Open MBravoS opened 1 year ago

MBravoS commented 1 year ago

Following the work we have been doing to implement the pyOpenSci suggestions in SciCM, I think now is a good time to give a comprehensive update to the splotch README file. It will improve the usability and (visual appearance) of the package, so I think we should follow the same guidelines, regardless of whether we decide further down the line to submit this package to pyOpenSci/JOSS. I also think it makes sense to combine this issue #30 for our next release.

AstroRobin commented 1 year ago

Yes, agreed with lumping this together with Params. Especially because the usage of params probably needs it's own quite detailed documentation to be used effectively.