.. _f-readmehelper:

module ``pycode.readme_helper``
===============================







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

module ``pyquickhelper.pycode.readme_helper``

Helpers about readme.


:githublink:`%|py|5`






Functions
+++++++++

+------------------------------------------------------------------------+-------------------------------+
| function                                                               | truncated documentation       |
+========================================================================+===============================+
| :func:`clean_readme <pyquickhelper.pycode.readme_helper.clean_readme>` | Clean instructions such as `` |
+------------------------------------------------------------------------+-------------------------------+








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

.. automodule:: pyquickhelper.pycode.readme_helper
    :members:
    :special-members: __init__
    :show-inheritance: