[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings
From: |
Markus Armbruster |
Subject: |
Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings |
Date: |
Thu, 17 Sep 2020 16:37:12 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) |
John Snow <jsnow@redhat.com> writes:
> As docstrings, they'll show up in documentation and IDE help.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> scripts/qapi/common.py | 50 ++++++++++++++++++++++++++++++------------
> 1 file changed, 36 insertions(+), 14 deletions(-)
>
> diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
> index af01348b35..38d380f0a9 100644
> --- a/scripts/qapi/common.py
> +++ b/scripts/qapi/common.py
> @@ -20,10 +20,18 @@
> c_name_trans = str.maketrans('.-', '__')
>
>
> -# ENUMName -> ENUM_NAME, EnumName1 -> ENUM_NAME1
> -# ENUM_NAME -> ENUM_NAME, ENUM_NAME1 -> ENUM_NAME1, ENUM_Name2 -> ENUM_NAME2
> -# ENUM24_Name -> ENUM24_NAME
> def camel_to_upper(value: str) -> str:
> + """
> + Converts CamelCase to CAMEL_CASE.
> +
> + Examples:
> + ENUMName -> ENUM_NAME
> + EnumName1 -> ENUM_NAME1
> + ENUM_NAME -> ENUM_NAME
> + ENUM_NAME1 -> ENUM_NAME1
> + ENUM_Name2 -> ENUM_NAME2
> + ENUM24_Name -> ENUM24_NAME
> + """
> c_fun_str = c_name(value, False)
> if value.isupper():
> return c_fun_str
> @@ -45,21 +53,33 @@ def camel_to_upper(value: str) -> str:
> def c_enum_const(type_name: str,
> const_name: str,
> prefix: Optional[str] = None) -> str:
> + """
> + Generate a C enumeration constant name.
> +
> + :param type_name: The name of the enumeration.
> + :param const_name: The name of this constant.
> + :param prefix: Optional, prefix that overrides the type_name.
> + """
Not actually a move. Suggest to retitle
qapi/common: Turn comments in docstrings, and add more
> if prefix is not None:
> type_name = prefix
> return camel_to_upper(type_name) + '_' + c_name(const_name,
> False).upper()
>
>
> -# Map @name to a valid C identifier.
> -# If @protect, avoid returning certain ticklish identifiers (like
> -# C keywords) by prepending 'q_'.
> -#
> -# Used for converting 'name' from a 'name':'type' qapi definition
> -# into a generated struct member, as well as converting type names
> -# into substrings of a generated C function name.
> -# '__a.b_c' -> '__a_b_c', 'x-foo' -> 'x_foo'
> -# protect=True: 'int' -> 'q_int'; protect=False: 'int' -> 'int'
> def c_name(name: str, protect: bool = True) -> str:
> + """
> + Map `name` to a valid C identifier.
> +
> + Used for converting 'name' from a 'name':'type' qapi definition
> + into a generated struct member, as well as converting type names
> + into substrings of a generated C function name.
> +
> + '__a.b_c' -> '__a_b_c', 'x-foo' -> 'x_foo'
> + protect=True: 'int' -> 'q_int'; protect=False: 'int' -> 'int'
> +
> + :param name: The name to map.
> + :param protect: If true, avoid returning certain ticklish identifiers
> + (like C keywords) by prepending 'q_'.
> + """
> # ANSI X3J11/88-090, 3.1.1
> c89_words = set(['auto', 'break', 'case', 'char', 'const', 'continue',
> 'default', 'do', 'double', 'else', 'enum', 'extern',
> @@ -135,9 +155,11 @@ def pop(self, amount: int = 4) -> int:
> INDENT = Indent(0)
>
>
> -# Generate @code with @kwds interpolated.
> -# Obey INDENT level, and strip EATSPACE.
> def cgen(code: str, **kwds: Union[str, int]) -> str:
> + """
> + Generate `code` with `kwds` interpolated.
> + Obey `INDENT`, and strip `EATSPACE`.
> + """
> raw = code % kwds
> if INDENT:
> raw, _ = re.subn(r'^(?!(#|$))', str(INDENT), raw, flags=re.MULTILINE)
Can you point to documentation on the docstring conventions and markup
to use?
- Re: [PATCH 08/37] qapi/common.py: Remove python compatibility workaround, (continued)
- [PATCH 12/37] qapi/common.py: check with pylint, John Snow, 2020/09/15
- [PATCH 11/37] qapi/common.py: Replace one-letter 'c' variable, John Snow, 2020/09/15
- [PATCH 14/37] qapi/common.py: Move comments into docstrings, John Snow, 2020/09/15
- Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings,
Markus Armbruster <=
- Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings, John Snow, 2020/09/17
- Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings, Eduardo Habkost, 2020/09/17
- Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings, John Snow, 2020/09/17
- Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings, Markus Armbruster, 2020/09/24
- Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings, John Snow, 2020/09/24
- Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings, Markus Armbruster, 2020/09/25
- Re: [PATCH 14/37] qapi/common.py: Move comments into docstrings, John Snow, 2020/09/25
[PATCH 13/37] qapi/common.py: add notational type hints, John Snow, 2020/09/15