You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
ReadTheDocs requires docstrings to have an additional newline between the header and the parameters if strings are not in this format it will not render properly. Therefore we want to put all docstrings into the following format
def some_function(a_number: int, a_string: str) -> str:
"""
A function that concatenates a string to
:param a_number: A number that ....
:type a_number: int
:param a_string: Some string that does something
:type a_string: str
:return: A concatenated integer with s
:rtype: str
"""
return str(a_number) + a_string
They should all have a heading describing the functionality and then have a new line then all the parameters. This will help users use our documentation and make things easier.
The text was updated successfully, but these errors were encountered:
ReadTheDocs requires docstrings to have an additional newline between the header and the parameters if strings are not in this format it will not render properly. Therefore we want to put all docstrings into the following format
They should all have a heading describing the functionality and then have a new line then all the parameters. This will help users use our documentation and make things easier.
The text was updated successfully, but these errors were encountered: