| Method Summary |
| |
__init__(self,
name,
descr,
type,
default)
Construct the documentation for a parameter. |
| |
__repr__(self)
|
string or None
|
default(self)
Return a string representation of the parameter's default value; or
None if it has no default value. |
markup.ParsedDocstring
|
descr(self)
Return a description of this parameter. |
string
|
name(self)
Return the name of this parameter. |
None
|
set_default(self,
default)
Set this parameter's default value. |
None
|
set_descr(self,
descr)
Set this parameter's description. |
None
|
set_type(self,
type)
Set this parameter's type. |
markup.ParsedDocstring
|
type(self)
Return a description of this parameter's type. |
| Shared Parameter Lists |
None or list of Param
|
shared_descr_params(self)
Return a list of Params that share the description given by this
parameter. |
None or Param
|
listed_under(self)
Return the parameter that this Param is listed under, if
any. |
None
|
set_shared_descr_params(self,
shared_descr_params)
Register a list of Params that share the description
given by this parameter. |
| |
remove_shared_descr_param(self,
param)
Remove a parameter from the list of Params that share the
description given by this parameter. |