diff options
| author | Galen Williamson <galen@vector35.com> | 2022-12-23 15:06:22 -0500 |
|---|---|---|
| committer | Galen Williamson <galen@vector35.com> | 2022-12-23 16:29:38 -0500 |
| commit | 47d44cd285530729b94e5960a93648047fc0b4ce (patch) | |
| tree | cf546c078c8843599b501ab489f3e25dd7d14552 /python/typeparser.py | |
| parent | 8e82653a052cb1b32e2d5ca53fd8f014df3e8737 (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/typeparser.py')
| -rw-r--r-- | python/typeparser.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/python/typeparser.py b/python/typeparser.py index 1b8fe57a..300c714e 100644 --- a/python/typeparser.py +++ b/python/typeparser.py @@ -425,6 +425,7 @@ class TypeParser(metaclass=_TypeParserMetaclass): def get_option_text(self, option: TypeParserOption, value: str) -> Optional[str]: """ Get the string representation of an option for passing to parse_type_* + :param option: Option type :param value: Option value :return: A string representing the option if the parser supports it, otherwise None @@ -438,6 +439,7 @@ class TypeParser(metaclass=_TypeParserMetaclass): ) -> Tuple[Optional[str], List[TypeParserError]]: """ Preprocess a block of source, returning the source that would be parsed + :param source: Source code to process :param file_name: Name of the file containing the source (does not need to exist on disk) :param platform: Platform to assume the source is relevant to @@ -457,6 +459,7 @@ class TypeParser(metaclass=_TypeParserMetaclass): ) -> Tuple[Optional[TypeParserResult], List[TypeParserError]]: """ Parse an entire block of source into types, variables, and functions + :param source: Source code to parse :param file_name: Name of the file containing the source (optional: exists on disk) :param platform: Platform to assume the types are relevant to @@ -474,6 +477,7 @@ class TypeParser(metaclass=_TypeParserMetaclass): ) -> Tuple[Optional[Tuple['types.QualifiedNameType', 'types.Type']], List[TypeParserError]]: """ Parse a single type and name from a string containing their definition. + :param source: Source code to parse :param platform: Platform to assume the types are relevant to :param existing_types: Optional map of all existing types to use for parsing context |
