search

davbeek / gitinspectorgui

0 stars 0 forks source link

Document code with docstrings #25

Open davbeek opened 1 day ago

davbeek commented 1 day ago

Document code using docstrings following Google docstring conventions.

We could also check the other Google conventions for other style recommendations.

Alberth289346 commented 1 day ago

I already wrote docstrings, you moved the information to comment near the parameters.

I still believe docstrings are better, the entire world uses them. Any contributor expects it there.

davbeek commented 1 day ago

I know, I agree. I changed my mind. What convinced my were some hints in VSCode giving the signature of methods including the types, and below that the docstring explanation in small font. That is indeed very useful as you said before.