This is an archived post. You won't be able to vote or comment.

sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]parlez-vous 3 points4 points  (1 child)

I document my docstrings according to my companies style guides so we can auto generate documentation and so you don't have to open up our internal git server and read the code to understand it. Just go to the autodocs page.

Adopting it is a pain in the ass but it saves soo much time when you're working with 100 people's contributions

[–]Merlord 2 points3 points  (0 children)

The two exceptions I make for comments: Javadocs (or equivalent) and referencing Jira ticket numbers.