diff options
author | Campbell Barton <campbell@blender.org> | 2022-09-19 07:22:31 +0300 |
---|---|---|
committer | Campbell Barton <campbell@blender.org> | 2022-09-19 07:24:31 +0300 |
commit | 4baa6e57bd4240e0dab1e2a1b426698ca4d593bc (patch) | |
tree | 8c9af26e0dbda778263f677c99ece9de0af7c61a /tests/python/modifiers.py | |
parent | 8a9f6a2e0a15ed6d5fcab7030249f0211b667d60 (diff) |
Cleanup: prefer 'arg' over 'params' for sphinx documentation
While both are supported, 'arg' is in more common use so prefer it.
Diffstat (limited to 'tests/python/modifiers.py')
-rw-r--r-- | tests/python/modifiers.py | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/tests/python/modifiers.py b/tests/python/modifiers.py index 11d696c3bed..93448841dfd 100644 --- a/tests/python/modifiers.py +++ b/tests/python/modifiers.py @@ -16,10 +16,12 @@ seed(0) def get_generate_modifiers_list(test_object_name, randomize=False): """ Construct a list of 'Generate' modifiers with default parameters. - :param test_object_name: str - name of test object. Some modifiers like boolean need an extra parameter beside - the default one. E.g. boolean needs object, mask needs vertex group etc... - The extra parameter name will be <test_object_name>_<modifier_type> - :param randomize: bool - if True shuffle the list of modifiers. + :arg test_object_name: Name of test object. Some modifiers like boolean need an extra parameter beside + the default one. E.g. boolean needs object, mask needs vertex group etc... + The extra parameter name will be <test_object_name>_<modifier_type> + :type test_object_name: str + :arg randomize: If True shuffle the list of modifiers. + :type randomize: bool :return: list of 'Generate' modifiers with default parameters. """ |