equinor/webviz-config

Type hinted return value of plugin init functions not supported by webviz docs

Closed this issue · 0 comments

asnyv commented

Describe the bug
webviz docs crashes if a plugin __init__ function is type hinted, as it attempts to use the return value annotation to describe an input argument

How to reproduce
Steps to reproduce the behavior:
e.g. in DataTable, include a return type hint None

def __init__(
        self,
        csv_file: Path,
        sorting: bool = True,
        filtering: bool = True,
        pagination: bool = True,
    ) -> None:

Then run webviz docs

Expected behavior
Ignore type hint for return value