From 4d9138e3ef76ce300f054a8cb07b1a2327b35a83 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Sat, 14 Sep 2019 01:06:50 -0400 Subject: lots of small documentation updates, mostly around making sure parameters are consistent and typed properly --- python/platform.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'python/platform.py') diff --git a/python/platform.py b/python/platform.py index 08b064fa..543e7c54 100644 --- a/python/platform.py +++ b/python/platform.py @@ -379,7 +379,8 @@ class Platform(with_metaclass(_PlatformMetaClass, object)): :param str source: source string to be parsed :param str filename: optional source filename - :param list(str) include_dirs: optional list of string filename include directories + :param include_dirs: optional list of string filename include directories + :type include_dirs: list(str) :param str auto_type_source: optional source of types if used for automatically generated types :return: :py:class:`TypeParserResult` (a SyntaxError is thrown on parse error) :rtype: TypeParserResult @@ -425,7 +426,8 @@ class Platform(with_metaclass(_PlatformMetaClass, object)): the optional list of directories provided in ``include_dirs``. :param str filename: filename of file to be parsed - :param list(str) include_dirs: optional list of string filename include directories + :param include_dirs: optional list of string filename include directories + :type include_dirs: list(str) :param str auto_type_source: optional source of types if used for automatically generated types :return: :py:class:`TypeParserResult` (a SyntaxError is thrown on parse error) :rtype: TypeParserResult -- cgit v1.3.1