
12 Jun
2023
12 Jun
'23
5:23 a.m.
Which docstring formatting standard am I supposed to be using? I noticed that some existing docstrings place an @ in front of parameter names in-line with otherwise unformatted descriptions, but that doesn't correspond to any of these:
Epytext syntax:
@type num_dogs: int @param num_dogs: the number of dogs
Sphinx syntax:
:param param1: The first parameter, defaults to 1. :type: int
Google syntax:
Args: param1 (int): The first parameter.
NumPy syntax:
Parameters ---------- param1 : int The first parameter.
--
This email has been checked for viruses by AVG antivirus software.
www.avg.com