Docstrings - one-line-vs multiple-line

Allgemeine Leitlinie, die Sie suchen, ist direkt in PEP257 in dem, was du zitiert hast, vielleicht brauchen Sie nur, um ihn in Aktion zu sehen.

Ihre Funktion ist ein guter Kandidat für eine Online-docstring ("wirklich offensichtlichen Fällen"):

def script_running(self, script):
    """Check if the script is running."""

In der Regel, wenn Sie sagen, dass eine Funktion wird geprüft, was es bedeutet, dass es zurück True oder False, aber wenn du möchtest, könnte spezifischer sein:

def script_running(self, script):
    """Return True if the script is running, False otherwise."""

Wieder alles in einer Zeile.

Ich würde wahrscheinlich auch ändern Sie den Namen der Funktion, denn es gibt keine Notwendigkeit zu betonen, auf was die Funktion arbeitet in seinem Namen (ein Skript). Ein Funktionsname sollte etwas süß, kurz und prägnant über das, was die Funktion tut. Wahrscheinlich geh ich mit:

def check_running(self, script):
    """Return True if the script is running, False otherwise."""

Manchmal die Funktion-name-Phantasie ist müde von all der Kodierung, aber man sollte trotzdem versuchen, Ihr bestes zu tun.

Für ein mehrzeiliges Beispiel, lassen Sie mich ausleihen einen docstring aus der google Richtlinien:

def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):
    """Fetches rows from a Bigtable.

    Retrieves rows pertaining to the given keys from the Table instance
    represented by big_table.  Silly things may happen if
    other_silly_variable is not None.

    Args:
        big_table: An open Bigtable Table instance.
        keys: A sequence of strings representing the key of each table row
            to fetch.
        other_silly_variable: Another optional variable, that has a much
            longer name than the other args, and which does nothing.

    Returns:
        A dict mapping keys to the corresponding table row data
        fetched. Each row is represented as a tuple of strings. For
        example:

        {'Serak': ('Rigel VII', 'Preparer'),
         'Zim': ('Irk', 'Invader'),
         'Lrrr': ('Omicron Persei 8', 'Emperor')}

        If a key from the keys argument is missing from the dictionary,
        then that row was not found in the table.

    Raises:
        IOError: An error occurred accessing the bigtable.Table object.
    """

Dies ein Weg sein könnte, um "zusammenfassen, dessen Verhalten und belegen Ihre Argumente, Rückgabewert(s), Nebenwirkungen, Ausnahmen und Beschränkungen auf, wenn es aufgerufen werden kann (wenn zutreffend)".

Das könnte Sie auch interessieren Blick auf diese Beispiel für die pypi-Projekt, dass es soll dokumentiert werden, mit Sphinx.

Meine 2 Cent: Richtlinien sind gedacht, um Ihnen eine Idee geben, über das, was Sie sollten und nicht tun sollten, aber Sie keine strengen Regeln, dass Sie blind Folgen. Also am Ende wählen, was Sie fühlen, besser zu sein.

Möchte ich klar etwas, was ist gesagt worden, in einem anderen die Antwort zu schlagen, die Maximale Leitungslänge mit einem docstring.

PEP8 sagt, dass Sie "Limit alle Zeilen auf maximal 79 Zeichen" auch wenn am Ende jeder macht 80.

Diese sind 80 charachters:

--------------------------------------------------------------------------------

Und dies kann eine Kante Fall, wo ein etwas langer Satz ist alles, was Sie wirklich brauchen:

def my_long_doc_function(arg1, arg2):
    """This docstring is long, it's a little looonger than the 80 charachters
    limit.

    """

Ist wie ein one-line-docstring, was bedeutet, dass ist bei wirklich offensichtlichen Fällen, aber auf deinen editor (mit 80 charachter limit) ist auf mehreren Linien.