Start add docs again
This commit is contained in:
parent
b7fc975379
commit
d414cc3ccd
61 changed files with 235 additions and 236 deletions
|
|
@ -130,7 +130,7 @@ def _set_property(caller, raw_string, **kwargs):
|
|||
caller (Object, Account): The user of the wizard.
|
||||
raw_string (str): Input from user on given node - the new value to set.
|
||||
|
||||
Kwargs:
|
||||
Keyword Args:
|
||||
test_parse (bool): If set (default True), parse raw_string for protfuncs and obj-refs and
|
||||
try to run result through literal_eval. The parser will be run in 'testing' mode and any
|
||||
parsing errors will shown to the user. Note that this is just for testing, the original
|
||||
|
|
@ -297,7 +297,7 @@ def _format_list_actions(*args, **kwargs):
|
|||
Args:
|
||||
actions (str): Available actions. The first letter of the action name will be assumed
|
||||
to be a shortcut.
|
||||
Kwargs:
|
||||
Keyword Args:
|
||||
prefix (str): Default prefix to use.
|
||||
Returns:
|
||||
string (str): Formatted footer for adding to the node text.
|
||||
|
|
@ -1175,7 +1175,7 @@ def _add_attr(caller, attr_string, **kwargs):
|
|||
attr = value
|
||||
attr;category = value
|
||||
attr;category;lockstring = value
|
||||
Kwargs:
|
||||
Keyword Args:
|
||||
delete (str): If this is set, attr_string is
|
||||
considered the name of the attribute to delete and
|
||||
no further parsing happens.
|
||||
|
|
@ -1362,7 +1362,7 @@ def _add_tag(caller, tag_string, **kwargs):
|
|||
tagname;category
|
||||
tagname;category;data
|
||||
|
||||
Kwargs:
|
||||
Keyword Args:
|
||||
delete (str): If this is set, tag_string is considered
|
||||
the name of the tag to delete.
|
||||
|
||||
|
|
@ -1911,7 +1911,7 @@ def _add_prototype_tag(caller, tag_string, **kwargs):
|
|||
caller (Object): Caller of menu.
|
||||
tag_string (str): Input from user - only tagname
|
||||
|
||||
Kwargs:
|
||||
Keyword Args:
|
||||
delete (str): If this is set, tag_string is considered
|
||||
the name of the tag to delete.
|
||||
|
||||
|
|
@ -2139,7 +2139,7 @@ def _format_diff_text_and_options(diff, minimal=True, **kwargs):
|
|||
diff (dict): A diff as produced by `prototype_diff`.
|
||||
minimal (bool, optional): Don't show KEEPs.
|
||||
|
||||
Kwargs:
|
||||
Keyword Args:
|
||||
any (any): Forwarded into the generated options as arguments to the callable.
|
||||
|
||||
Returns:
|
||||
|
|
|
|||
|
|
@ -330,7 +330,7 @@ def search_prototype(key=None, tags=None, require_single=False, return_iterators
|
|||
"""
|
||||
Find prototypes based on key and/or tags, or all prototypes.
|
||||
|
||||
Kwargs:
|
||||
Keyword Args:
|
||||
key (str): An exact or partial key to query for.
|
||||
tags (str or list): Tag key or keys to query for. These
|
||||
will always be applied with the 'db_protototype'
|
||||
|
|
@ -730,7 +730,7 @@ def protfunc_parser(value, available_functions=None, testing=False, stacktrace=F
|
|||
behave differently.
|
||||
stacktrace (bool, optional): If set, print the stack parsing process of the protfunc-parser.
|
||||
|
||||
Kwargs:
|
||||
Keyword Args:
|
||||
session (Session): Passed to protfunc. Session of the entity spawning the prototype.
|
||||
protototype (dict): Passed to protfunc. The dict this protfunc is a part of.
|
||||
current_key(str): Passed to protfunc. The key in the prototype that will hold this value.
|
||||
|
|
|
|||
|
|
@ -844,7 +844,7 @@ def spawn(*prototypes, **kwargs):
|
|||
prototypes (str or dict): Each argument should either be a
|
||||
prototype_key (will be used to find the prototype) or a full prototype
|
||||
dictionary. These will be batched-spawned as one object each.
|
||||
Kwargs:
|
||||
Keyword Args:
|
||||
prototype_modules (str or list): A python-path to a prototype
|
||||
module, or a list of such paths. These will be used to build
|
||||
the global protparents dictionary accessible by the input
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue