darglint icon indicating copy to clipboard operation
darglint copied to clipboard

A python documentation linter which checks that the docstring description matches the definition.

Results 72 darglint issues
Sort by recently updated
recently updated
newest added

Hi @terrencepreilly! Firstly, I wanted to chime in to say thank you for making `darglint`. It's a great addition to the ecosystem :smile:. Speaking of the ecosystem, I'm wondering if...

enhancement

I have this code: ```python def optional(filename: str) -> str: """ This functions is used for compatibility reasons. It masks the old `optional` class with the name error. Now `invalid-name`...

Not sure if this is actually something that should be addressed by `darglint`, but I just ran into a very confusing issue where I had a typo in for the...

Given the following function: ```python def key_if_required(key: str, required: bool = True) -> dict: """ Check if key is required and return a dictionary. :param `key`: The name of the...

It looks like when a decorator is added, flake8+darglint report the line number off by +1 so the line checked for noqa is shifted. Of the three methods below, the...

bug

If a result of a function, that returns exception is raised, darglint treats this function itself as an exception. Consider the following example: ```python3 def raise_an_error() -> Exception: return Exception()...

It would be preferable to be able to use the full path e.g. `aiohttp.web.HTTPException` in an example such as: ``` from aiohttp import web def foo(): """ Raises: aiohttp.web.HTTPException """...

When a function/method uses `yield`, Darglint outputs an error as follows: `DAR301: foo_function: Missing "Yields" in Docstring: - yield` Though this is correct for e.g. Google-style docstrings, Sphinx itself doesn't...

Bumps [py](https://github.com/pytest-dev/py) from 1.8.0 to 1.10.0. Changelog Sourced from py's changelog. 1.10.0 (2020-12-12) Fix a regular expression DoS vulnerability in the py.path.svnwc SVN blame functionality (CVE-2020-29651) Update vendored apipkg: 1.4...

dependencies

Bumps [pygments](https://github.com/pygments/pygments) from 2.5.2 to 2.7.4. Release notes Sourced from pygments's releases. 2.7.4 Updated lexers: Apache configurations: Improve handling of malformed tags (#1656) CSS: Add support for variables (#1633, #1666)...

dependencies