search

jsh9 / pydoclint

A Python docstring linter that checks arguments, returns, yields, and raises sections
https://pypi.org/project/pydoclint/
MIT License
149 stars 15 forks source link

Tab vs. spaces in baseline #143

Closed cidrblock closed 3 months ago

cidrblock commented 4 months ago

Was curious about the logic of using tabs vs. spaces in the baseline file?

We generally go the spaces route and have had to exempt the baseline file from some auto-formaters.

https://github.com/jsh9/pydoclint/blob/457a559af2cfe90d179c73dc0bc6ec807a30e615/pydoclint/baseline.py#L19

Would you be open to a PR to switch it?

BTW- TY for everything you've done here, we're using pydoclint in all our projects.

jsh9 commented 4 months ago

Hi @cidrblock , yes sure, please feel free to open a PR. Could you retain backward compatibility though? (Meaning: baseline files with tabs can still be parsed correctly with your code change.)

And thank you for using pydoclint in your projects and provide feedback to me!