darglint

darglint copied to clipboard

**Sphinx Docstring Style**: ``` """Called when :py:meth:`~mymod.MyClass.my_method` raises an error. The scheduler uses the output of this method to determine whether the command should be immediately interrupted. :param exc_type: The...

JulianOrteil

Both [Typer](https://typer.tiangolo.com/), a python CLI framework, and the older [click](https://pypi.org/project/click/) framework on which it is based, will automatically extract user documentation from function docstrings. Separate from that, `typer` will extract...

tosascott

I noticed the project is currently using the full `poetry` package as its build backend. There's now a preferred, lightweight `poetry-core` package. What's the benefit? To quote the [project's readme](https://github.com/python-poetry/poetry-core#why-is-this-required):...

branchv

Support `abc.abstractmethod` in abstract detection

2

Fixes #183 Specifically, we're allowing any `XYZ.abstractmethod` decorator, as some might roll their own or add bells and whistles on top of `abc.abstractmethod`.

thejcannon

From PEP-257: "The docstring for a module should generally list the classes, exceptions and functions (and any other objects) that are exported by the module, with a one-line summary of...

danhje

Description ======= When trying to install a development bundle of `darglint`, an error message appears. Here is the log I got when I tryed to use `pip install -e .`...

saroad2

Numpy Stability Tracking Issue

11

Issues with the Numpy parser and reporter should be added here for the moment. Once it has stabilized, or a couple weeks have passed, I'll close this bug.

terrencepreilly

False positive (?) DAR101 for argument lists with blank lines

3

For example, Sphinx (RST) requires a blank line before and after a bullet list. However, this leads to `darglint` missing all of the arguments that follow these blank lines. Here...

ezwelty

Feature: support ast type hints subscript

9

Hello, and thank you for dev Darglint 🙂 **This Pr is intended to allow more complicated types hints to be detected for parameters and return**. (With "[") Ex: List[int], Union[int,...

lucasiscovici2

### Summary When using backticks (``) on parameter type for built in type parameters (str, int, list...) and modules (os, re...), the DAR103 error is shown. This doesn't happen with...

justbispo