fix syntax error and docstring typos

This commit is contained in:
Cal 2022-03-09 09:53:39 -07:00
parent b413e0f7f2
commit 338d7c81b9

View file

@ -22,7 +22,7 @@ def _helper(x):
# use underscore to NOT make the function available as a callable # use underscore to NOT make the function available as a callable
def funcname(*args, **kwargs): def funcname(*args, **kwargs):
# this can be accecssed as $funcname(*args, **kwargs) # this can be accessed as $funcname(*args, **kwargs)
# it must always accept *args and **kwargs. # it must always accept *args and **kwargs.
... ...
return something return something
@ -31,7 +31,7 @@ def funcname(*args, **kwargs):
Usage: Usage:
```python ```python
from evennia.utils.funcparser from evennia.utils.funcparser import FuncParser
parser = FuncParser("path.to.module_with_callables") parser = FuncParser("path.to.module_with_callables")
result = parser.parse("String with $funcname() in it") result = parser.parse("String with $funcname() in it")
@ -1097,7 +1097,7 @@ def funcparser_callable_you(
Examples: Examples:
This can be used by the say or emote hooks to pass actor stance This can be used by the say or emote hooks to pass actor stance
strings. This should usually be combined with the $inflect() callable. strings. This should usually be combined with the $conj() callable.
- `With a grin, $you() $conj(jump) at $you(tommy).` - `With a grin, $you() $conj(jump) at $you(tommy).`
@ -1181,7 +1181,7 @@ def funcparser_callable_conjugate(*args, caller=None, receiver=None, **kwargs):
def funcparser_callable_pronoun(*args, caller=None, receiver=None, capitalize=False, **kwargs): def funcparser_callable_pronoun(*args, caller=None, receiver=None, capitalize=False, **kwargs):
""" """
Usage: $prop(word, [options]) Usage: $pron(word, [options])
Adjust pronouns to the expected form. Pronouns are words you use instead of a Adjust pronouns to the expected form. Pronouns are words you use instead of a
proper name, such as 'him', 'herself', 'theirs' etc. These look different proper name, such as 'him', 'herself', 'theirs' etc. These look different
@ -1217,7 +1217,7 @@ def funcparser_callable_pronoun(*args, caller=None, receiver=None, capitalize=Fa
`male`/`female`/`neutral`/`plural` (plural is considered a gender for this purpose). `male`/`female`/`neutral`/`plural` (plural is considered a gender for this purpose).
If no `gender` property/callable is found, `neutral` is used as a fallback. If no `gender` property/callable is found, `neutral` is used as a fallback.
The pronoun-type default (if not spefified in call) is `subject pronoun`. The pronoun-type default (if not specified in call) is `subject pronoun`.
Args: Args:
pronoun (str): Input argument to parsed call. This can be any of the pronouns pronoun (str): Input argument to parsed call. This can be any of the pronouns
@ -1287,7 +1287,7 @@ def funcparser_callable_pronoun(*args, caller=None, receiver=None, capitalize=Fa
default_viewpoint = "2nd person" default_viewpoint = "2nd person"
if hasattr(caller, "gender"): if hasattr(caller, "gender"):
if callable(caller, gender): if callable(caller.gender):
default_gender = caller.gender() default_gender = caller.gender()
else: else:
default_gender = caller.gender default_gender = caller.gender
@ -1315,7 +1315,7 @@ def funcparser_callable_pronoun_capitalize(
*args, caller=None, receiver=None, capitalize=True, **kwargs *args, caller=None, receiver=None, capitalize=True, **kwargs
): ):
""" """
Usage: $Pron(word) - always maps to a capitalized word. Usage: $Pron(word, [options]) - always maps to a capitalized word.
""" """
return funcparser_callable_pronoun( return funcparser_callable_pronoun(