Programmiererforum

    """

Function description

Parameters
-----------
param1: str or list
A description for the parameter

Returns
-----------
Dictionary
Some info about what is returned

Examples
-----------
>>> output = somefunction(param1)

"""

Ich entwickle Dokumentation für ein Paket und wenn ich die Sphinx-Dokumente erstelle, erhalte ich Doppelpunkte
[img]https://i .sstatic.net/8EmeK.png[/img]

für alle Felder für jede Funktionsdefinition.
Ich verwende den Numpydoc-Stil für meine Dokumentzeichenfolgen und es gibt keine Doppelpunkte in diesen Dokumenten, um anzugeben, woher sie kommen könnten:
[code] """

Function description

Parameters
-----------
param1: str or list
A description for the parameter

Returns
-----------
Dictionary
Some info about what is returned

Examples
-----------
>>> output = somefunction(param1)

"""
[/code]
Ist das schon einmal jemandem passiert? Es ist erwähnenswert, dass dies beim Feld Beispiele [b]nicht[/b] der Fall ist. Nur Parameter, Rückgaben und Rückgabetyp.