Docstring format about gridcal HOT 6 CLOSED

Good morning,

In the future please don't merge PR with "WiP" in the title, #58 wasn't completely ready. There was an explanation in it: the new proposed docstring format is in reStructuredText to be compatible with autodoc/Sphinx.

That being the most common and official Python docstring format, as far as I know, pycharm should be able to recognize it. See here, although I didn't test it (I use either good old vim on Linux and Geany on Windows).

Thanks,

Michel

from gridcal.

In the future please don't merge PR with "WiP" in the title, #58 wasn't completely ready.

Actually, this might be a good indication that a contribution guide might be useful. Something like this: https://gitlab.com/miek770/energy_tools/blob/master/CONTRIBUTING.md. I shamelessly copied and adapted pandapower's guide for this small project.

How would you like contributors to present branches that are not ready to be merged, but ready for discussion and feedback? I think the "Work in progress / WiP" prefix is widespread, but I could also have done it in an issue an link to my own branch.

Michel

from gridcal.

Actually I don't know if you can have a github branch without a pull request appearing (I guess so)

I'd propose that only final pull requests are made if that is possible. That way I can be more effective.

from gridcal.

Noted. I won't create PR until they're ready to be merge (IMO), and will include something to this effect in the doc. I can create a branch in my fork and link to it in an issue in the main repo, without creating a PR.

About the docstring format, are you ok with reStructuredText? Did you manage to set pycharm accordingly?

from gridcal.

I have no strong opinion about reStructuredText (I had to google it...)
Actually is what I have in pycharm by default at least in windows.
It seems alright to me.

from gridcal.

Great, I think this issue could be closed if that's ok with you.

from gridcal.