Ignore warning on missing return

[awgymer]

Is it possible to somehow prevent/ignore a warning at a specific location in the code?

WARNING griffe: <mypackage>/module.py:315: No type or annotation for returned value 1

When I run build with --strict this is causing my docs build to fail, but for this one particular method it is not currently possible to accurately type the return value. I would rather leave it unannotated that add e.g. Any as I feel that is misleading (it can't be really be Any!).

Is it possible to get griffe to not warn on this line somehow?

[pawamoy]

There is work in progress to make warnings configurable, but even that wouldn't be fine-grain enough to enable/disable warnings on specific lines of code, no 😕

We could imagine an extension that combines with warnings configuration and reads some kind of # noqa comments, or adding support for configuration files with per-file-ignore-like options (more like per-object-ignore), but that won't happen soon.

Note that you can document the return type with natural language in your docstring, so that you at least document something, even if not a proper object. Would that work for you?

[awgymer]

The docstring contains a Returns section, the issue is rather that the signature has no return type-hint I think

[pawamoy]

Yes, in that case you can add a type to the docstring itself:

def my_func():
    """Summary.

    Returns:
        (natural language describing the type of the returned value): Description of the returned value.
    """

Format is (type): description. Reference: https://mkdocstrings.github.io/griffe/reference/docstrings/#google-section-returns.

[awgymer]

Ohhhhh sorry that makes sense now

[pawamoy]

No worries!