lsst.obs.base  21.0.0-12-ge5f8019+e3fa360c9c
Public Member Functions | List of all members
butlerCmdDocGen.ButlerCmdDocGen Class Reference
Inheritance diagram for butlerCmdDocGen.ButlerCmdDocGen:

Public Member Functions

def list_commands (self, ctx)
 
def get_command (self, context, name)
 

Detailed Description

Definition at line 31 of file butlerCmdDocGen.py.

Member Function Documentation

◆ get_command()

def butlerCmdDocGen.ButlerCmdDocGen.get_command (   self,
  context,
  name 
)
Get a click command provided by this package.

Parameters
----------
ctx : click.Context
    The current Click context.
name : string
    The name of the command to return.

Returns
-------
command : click.Command
    A Command that wraps a callable command function.

Definition at line 48 of file butlerCmdDocGen.py.

◆ list_commands()

def butlerCmdDocGen.ButlerCmdDocGen.list_commands (   self,
  ctx 
)
List the click commands provided by this package.

Parameters
----------
ctx : click.Context
    The current Click context.

Returns
-------
commands : `list` [`str`]
    The names of the commands that can be called by the butler command.

Definition at line 33 of file butlerCmdDocGen.py.


The documentation for this class was generated from the following file: