add a note on get_info_2() #4270

This commit is contained in:
Andrej730
2024-02-01 16:30:50 +05:00
parent 3d7e8d7c6c
commit 73817acdff
@@ -505,6 +505,16 @@ class entity_instance(object):
__dict__ = property(get_info)
def get_info_2(self, include_identifier=True, recursive=False, return_type=dict, ignore=()):
"""More perfomant version of `.get_info()` but with limited arguments values.\n
Method has exactly the same signature as `.get_info()` but it doesn't support getting information non-recursively.
Currently supported arguments values:
* include_identifier: `True`
* recursive: `True` (will fail with default `False` value from `.get_info()`)
* return_type: `dict`
* ignore: `()` (empty tuple)
"""
assert include_identifier
assert recursive
assert return_type is dict