summaryrefslogtreecommitdiff
path: root/python/types.py
diff options
context:
space:
mode:
authorGalen Williamson <galen@vector35.com>2022-12-23 15:06:22 -0500
committerGalen Williamson <galen@vector35.com>2022-12-23 16:29:38 -0500
commit47d44cd285530729b94e5960a93648047fc0b4ce (patch)
treecf546c078c8843599b501ab489f3e25dd7d14552 /python/types.py
parent8e82653a052cb1b32e2d5ca53fd8f014df3e8737 (diff)
Fixed missing newlines before `:param` in docstrings
This was causing the generated html to not show the param lines correctly.
Diffstat (limited to 'python/types.py')
-rw-r--r--python/types.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/python/types.py b/python/types.py
index 51f71c90..4c1eb3ab 100644
--- a/python/types.py
+++ b/python/types.py
@@ -589,6 +589,7 @@ class TypeBuilder:
) -> 'IntegerBuilder':
"""
``int`` class method for creating an int Type.
+
:param int width: width of the integer in bytes
:param bool sign: optional variable representing signedness
:param str altname: alternate name for type
@@ -599,6 +600,7 @@ class TypeBuilder:
def float(width: _int, altname: str = "") -> 'FloatBuilder':
"""
``float`` class method for creating floating point Types.
+
:param int width: width of the floating point number in bytes
:param str altname: alternate name for type
"""
@@ -608,6 +610,7 @@ class TypeBuilder:
def wide_char(width: _int, altname: str = "") -> 'WideCharBuilder':
"""
``wide_char`` class method for creating wide char Types.
+
:param int width: width of the wide character in bytes
:param str altname: alternate name for type
"""
@@ -660,6 +663,7 @@ class TypeBuilder:
) -> 'FunctionBuilder':
"""
``function`` class method for creating a function Type.
+
:param Type ret: return Type of the function
:param params: list of parameter Types
:type params: list(Type)
@@ -1968,6 +1972,7 @@ class Type:
def int(width: _int, sign: BoolWithConfidenceType = True, alternate_name: str = "") -> 'IntegerType':
"""
``int`` class method for creating an int Type.
+
:param int width: width of the integer in bytes
:param bool sign: optional variable representing signedness
:param str alternate_name: alternate name for type
@@ -1978,6 +1983,7 @@ class Type:
def float(width: _int, alternate_name: str = "") -> 'FloatType':
"""
``float`` class method for creating floating point Types.
+
:param int width: width of the floating point number in bytes
:param str alternate_name: alternate name for type
"""
@@ -1987,6 +1993,7 @@ class Type:
def wide_char(width: _int, alternate_name: str = "") -> 'WideCharType':
"""
``wide_char`` class method for creating wide char Types.
+
:param int width: width of the wide character in bytes
:param str alternate_name: alternate name for type
"""
@@ -2061,6 +2068,7 @@ class Type:
) -> 'FunctionType':
"""
``function`` class method for creating a function Type.
+
:param Type ret: return Type of the function
:param params: list of parameter Types
:type params: list(Type)