Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstring linting #209

Open
eliotwrobson opened this issue Feb 28, 2024 · 3 comments
Open

Add docstring linting #209

eliotwrobson opened this issue Feb 28, 2024 · 3 comments

Comments

@eliotwrobson
Copy link
Collaborator

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
Copy link
Owner

caleb531 commented Mar 1, 2024

@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
Copy link
Collaborator Author

@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
Copy link
Collaborator Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants