:py:mod:`pickax.help`
=====================

.. py:module:: pickax.help

.. autodoc2-docstring:: pickax.help
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`print_help <pickax.help.print_help>`
     - .. autodoc2-docstring:: pickax.help.print_help
          :summary:
   * - :py:obj:`key_help <pickax.help.key_help>`
     - .. autodoc2-docstring:: pickax.help.key_help
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`keymap_desc <pickax.help.keymap_desc>`
     - .. autodoc2-docstring:: pickax.help.keymap_desc
          :summary:

API
~~~

.. py:data:: keymap_desc
   :canonical: pickax.help.keymap_desc
   :value: None

   .. autodoc2-docstring:: pickax.help.keymap_desc

.. py:function:: print_help(keymap)
   :canonical: pickax.help.print_help

   .. autodoc2-docstring:: pickax.help.print_help

.. py:function:: key_help(keymap)
   :canonical: pickax.help.key_help

   .. autodoc2-docstring:: pickax.help.key_help