Hoppa till innehållet

Ämne på Diskussion:Developer guidelines/Flow

Docstrings-format för parametrar?

2
Mattias Östmar (WMSE) (diskussionbidrag)

Vet inte om detta är viktigt, men jag tycker själv det varit svårt att hitta nån resonable default i PEP8 respektive PEP257 som ska täcka docstrings. Nån som vet vad vi kan ha för gemensam standard?

Exempel:

@param names: list of strings to be flipped (befintlig kod)

:param names: list of strings to be flipped (inbyggt i pyCharm)

:names: list of strings to be flipped (sett nånstans på the interwebz)

Eller till och med:

...

Args:

name: list of strings to be flipped

Returns:

....

From Google Style Guide: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html]])

Sebastian Berlin (WMSE) (diskussionbidrag)

Jag försökte hitta något om detta i Phab:T156903, utan större framgång.