search

terrencepreilly / darglint

A python documentation linter which checks that the docstring description matches the definition.
MIT License
483 stars 41 forks source link

Add support for epytext docstring format #159

Closed xqt closed 3 years ago

xqt commented 3 years ago

Please add support for epytext docstring format which is a bit similar to reST (Sphinx) Format. See also: Different Python Docstring Formats

terrencepreilly commented 3 years ago

It looks like the tooling for epytext is pretty out-of-date. (epydoc hasn't been updated since 2008.) I've never heard of any projects using it. Can you point to some large projects which use it? I'd rather focus on actually improving support for the formats we already support.

If it's important to a project of yours, you're welcome to fork darglint and write a new parser for this format. Or, I'd accept PRs to move darglint towards a plugin model. (Just be sure to communicate the plans for it beforehand, so that we can make sure it turns out clean.)