txt - guardar una lista en un archivo python

¿Cómo doy un documento en Python?

Question

Eso es. Si desea documentar una función o una clase, coloque una cadena justo después de la definición. Por ejemplo:

def foo():
    """This function does nothing."""
    pass

Pero, ¿y un módulo? ¿Cómo puedo documentar qué hace un file.py ?

Answer 1

Es fácil, solo agrega una docstring en la parte superior del módulo.

Answer 2

Lo haces de la misma manera. Ponga una cadena como la primera declaración en el módulo.

Answer 3

Para los paquetes, puede documentarlo en __init__.py . Para los módulos, puede agregar una docstring simplemente en el archivo del módulo.

Toda la información está aquí: http://www.python.org/dev/peps/pep-0257/

Answer 4

Agregue su docstring como la primera declaración en el módulo .

Como me gusta ver un ejemplo:

"""
Your module''s verbose yet thorough docstring.
"""

import foo

# ...

Answer 5

Aquí hay un ejemplo de Google Style Python Docstrings sobre cómo se puede documentar el módulo. Básicamente, hay información sobre un módulo, cómo ejecutarlo e información sobre las variables de nivel de módulo y la lista de elementos ToDo.

"""Example Google style docstrings.

This module demonstrates documentation as specified by the `Google
Python Style Guide`_. Docstrings may extend over multiple lines.
Sections are created with a section header and a colon followed by a
block of indented text.

Example:
    Examples can be given using either the ``Example`` or ``Examples``
    sections. Sections support any reStructuredText formatting, including
    literal blocks::

        $ python example_google.py

Section breaks are created by resuming unindented text. Section breaks
are also implicitly created anytime a new section starts.

Attributes:
    module_level_variable1 (int): Module level variables may be documented in
        either the ``Attributes`` section of the module docstring, or in an
        inline docstring immediately following the variable.

        Either form is acceptable, but the two should not be mixed. Choose
        one convention to document module level variables and be consistent
        with it.

Todo:
    * For module TODOs
    * You have to also use ``sphinx.ext.todo`` extension

.. _Google Python Style Guide:   
http://google.github.io/styleguide/pyguide.html

"""

module_level_variable1 = 12345

def my_function():   
    pass 
... 
...