.. _doot.cmds.help_cmd:
  
==================
doot.cmds.help_cmd
==================
  


.. py:module:: doot.cmds.help_cmd

 











Classes
-------
  


.. autoapisummary::

    doot.cmds.help_cmd._HelpDoot_m
    doot.cmds.help_cmd._HelpCmd_m
    doot.cmds.help_cmd._HelpTask_m
    doot.cmds.help_cmd.HelpCmd

Module Contents
===============


.. doot.cmds.help_cmd._HelpDoot_m:
  


.. py:class:: _HelpDoot_m

 

   
   .. py:method:: _doot_help(plugins: jgdv.structs.chainguard.ChainGuard) -> list[str]



 

.. doot.cmds.help_cmd._HelpCmd_m:
  


.. py:class:: _HelpCmd_m

 

   
   .. py:method:: _cmd_help(*, idx: int, cmd: Any) -> list[str]



   
   .. py:method:: _cmd_param_assignments(idx: int, cmd: Any) -> list[jgdv.Maybe[str]]



 

.. doot.cmds.help_cmd._HelpTask_m:
  


.. py:class:: _HelpTask_m

 

   
   .. py:method:: _task_help(count: int, spec: doot.workflow._interface.TaskSpec_i) -> list[jgdv.Maybe[str]]


      Print the help for a task spec



   
   .. py:method:: _task_param_assignments(spec: doot.workflow._interface.TaskSpec_i) -> list



 

.. _doot.cmds.help_cmd.HelpCmd:
  


.. py:class:: HelpCmd(name: jgdv.Maybe[str] = None)

   Bases: :py:obj:`doot.cmds._base.BaseCommand` 
  
   Generic implementations of command methods


   .. py:attribute:: _name
      :value: 'help'


   .. py:attribute:: _help
      :value: ('Print info about the specified cmd or task', 'Can also be triggered by passing --help to any...


   
   .. py:method:: param_specs() -> list


      Provide parameter specs for parsing into doot.args.cmds