search

caleb531 / automata

A Python library for simulating finite automata, pushdown automata, and Turing machines
https://caleb531.github.io/automata/
MIT License
338 stars 63 forks source link

Add docstring linting #209

Open eliotwrobson opened 6 months ago

eliotwrobson commented 6 months ago

See title, would be nice to be able to lint docstrings that are part of the public interface. https://github.com/jsh9/pydoclint?tab=readme-ov-file

caleb531 commented 6 months ago

@eliotwrobson I like the idea of adding this to the toolchain, if you or someone else is able to implement it (I myself don't have the time in this season).

eliotwrobson commented 6 months ago

@caleb531 I'm going to have to set this up for another project pretty soon, so I can copy over what I use for that to the lint action 👍🏽

eliotwrobson commented 6 months ago

After playing around for a bit, the docstring linter looks really strict. Might take some fussing with the options before being able to use it here.