.. _f-fakefunctiontodocumentation:

module ``helpgen._fake_function_to_documentation``
==================================================







Short summary
+++++++++++++

module ``pyquickhelper.helpgen._fake_function_to_documentation``

This file is to compare different documentation style.


:githublink:`%|py|6`






Functions
+++++++++

+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| function                                                              | truncated documentation                                                                |
+=======================================================================+========================================================================================+
| :func:`f1 <pyquickhelper.helpgen._fake_function_to_documentation.f1>` | Addition 1                                                                             |
+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :func:`f2 <pyquickhelper.helpgen._fake_function_to_documentation.f2>` | Addition 2                                                                             |
+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :func:`f3 <pyquickhelper.helpgen._fake_function_to_documentation.f3>` | Addition 3                                                                             |
+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :func:`f4 <pyquickhelper.helpgen._fake_function_to_documentation.f4>` | Addition 4                                                                             |
+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :func:`f5 <pyquickhelper.helpgen._fake_function_to_documentation.f5>` | Addition 5 Parameters ---------- a: parameter a b: parameter b Returns ------- ``a+b`` |
+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :func:`f6 <pyquickhelper.helpgen._fake_function_to_documentation.f6>` | Addition 6 Args: a: parameter a b: parameter b Returns: ``a+b``                        |
+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: pyquickhelper.helpgen._fake_function_to_documentation
    :members:
    :special-members: __init__
    :show-inheritance: