TypedDict
classes gets a griffe warning "Parameter does not appear in the function signature" when correctly including the parameters in the docstring. (Note: TypedDict
's do not include an explicit def __init__()
constructor)
class MyTypedDict(TypedDict):
"""
Parameters
----------
first_dict_key: str
First dictionary key.
second_dict_key: str
Second dictionary key.
"""
first_dict_key: str
second_dict_key: str
$ mkdocs build --strict
WARNING - griffe: src\aemo_databricks\sql\types.py:28: Parameter 'first_dict_key' does not appear in the function signature
WARNING - griffe: src\aemo_databricks\sql\types.py:28: Parameter 'second_dict_key' does not appear in the function signature
These warnings should not be raised, since (unlike normal python classes) first_dict_key
and second_dict_key
are parameters for instantiating the class, not class attributes.
I'm using --strict
flag for cicd testing of my MkDocs documentation, my cicd pipeline is failing due to this warning.
Pay now to fund the work behind this issue.
Get updates on progress being made.
Maintainer is rewarded once the issue is completed.
You're funding impactful open source efforts
You want to contribute to this effort
You want to get funding like this too