summaryrefslogtreecommitdiff
path: root/python/types.py
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2022-05-06 00:25:41 -0400
committerJordan Wiens <jordan@psifertex.com>2022-05-06 00:25:41 -0400
commitbfeba3302e995fdba373603533fce54bf788adff (patch)
tree2e4aadbb53e43a7022167ecdff4e241474279e6d /python/types.py
parent245ee620d94a21d5e0005bd634a10bb6163efb64 (diff)
many pydoc formatting cleanups, added deprecated decorator and replaced ad-hoc messages with consistent decorator
Diffstat (limited to 'python/types.py')
-rw-r--r--python/types.py8
1 files changed, 7 insertions, 1 deletions
diff --git a/python/types.py b/python/types.py
index 3d1dc73e..65f58192 100644
--- a/python/types.py
+++ b/python/types.py
@@ -1617,6 +1617,7 @@ class Type:
) -> str:
"""
Get string representation for this type
+
:param TokenEscapingType escaping: How to escape non-parsable strings in types
:return: String for type
:rtype: str
@@ -1634,6 +1635,7 @@ class Type:
) -> str:
"""
Get the string to be printed before this type's name in a representation of it
+
:param TokenEscapingType escaping: How to escape non-parsable strings in types
:return: String for type representation before the name
:rtype: str
@@ -1652,7 +1654,8 @@ class Type:
self, escaping: TokenEscapingType = TokenEscapingType.NoTokenEscapingType
) -> str:
"""
- Get the string to be printed after this type's name in a representation of it
+ Get the string to be printed after this type's name in a representation
+
:param TokenEscapingType escaping: How to escape non-parsable strings in types
:return: String for type representation after the name
:rtype: str
@@ -1678,6 +1681,7 @@ class Type:
) -> List['_function.InstructionTextToken']:
"""
Get a list of tokens for the definition of a type
+
:param int base_confidence: Confidence of this type
:param TokenEscapingType escaping: How to escape non-parsable strings in types
:return: List of tokens
@@ -1705,6 +1709,7 @@ class Type:
) -> List['_function.InstructionTextToken']:
"""
Get a list of tokens for the definition of a type that are placed before the type name
+
:param int base_confidence: Confidence of this type
:param TokenEscapingType escaping: How to escape non-parsable strings in types
:return: List of tokens
@@ -1735,6 +1740,7 @@ class Type:
) -> List['_function.InstructionTextToken']:
"""
Get a list of tokens for the definition of a type that are placed after the type name
+
:param int base_confidence: Confidence of this type
:param TokenEscapingType escaping: How to escape non-parsable strings in types
:return: List of tokens