rows icon indicating copy to clipboard operation
rows copied to clipboard

Add docstrings to all functions and methods

Open turicas opened this issue 6 years ago • 4 comments

turicas avatar Dec 01 '18 22:12 turicas

@turicas can I help with this one ?

matpfernandes avatar Apr 24 '19 21:04 matpfernandes

@matpfernandes are you still working at this issue ? @naanadr and I wanna to improve this. Are you using a specific style for Docstrings ?

disouzaleo avatar Oct 28 '19 14:10 disouzaleo

@disouzaleo No, fell free to pick this one :)

matpfernandes avatar Oct 30 '19 14:10 matpfernandes

Just to give some clarifications about the issue, we pretend to follow the PEP 257 conventions as instructed by @turicas. This should make software docs generation easier. It is worth to say that the rules that are mentioned at PEP 257 document are only conventions, or a good rule of thumb. That said, there are a number of different styles that goes into the PEP direction. Python docstrings can be written in many different flavors like Epytext, reST, Google or Numpy/Scipy. And all of them can be used in Sphinx and follow PEP 257 rules. IMHO the easiest one is the Google style as explained here, but should not be the best option if we want to write a more detailed documentation. So we need to decide what fit best in our use case.

disouzaleo avatar Nov 01 '19 00:11 disouzaleo