Baseline integration

[Egorrko]

This PR experiment is about generating and checking errors using the baseline file.

I understand that I haven't written the tests yet. Please rate this PR as an idea.

[jsh9]

Hi @Egorrko , I think this is a cool idea. Please feel free to keep experimenting on this branch.

[Egorrko]

@jsh9 I think this PR is ready for your viewing and testing

[jsh9]

Hi @Egorrko , would you mind writing some instructions on how to use this feature? You can reply here and I'll put them into README myself. Thanks!

[Egorrko]

Sorry about my CI linting problems
I can't reproduce this tox environment to check all this problems myself

[Egorrko]

Look at this change:
I think it could be useful for most of users

[jsh9]

Hey, I'm sorry but I don't quite understand your comment here.

[Egorrko]

I think that now for most of the projects to keep the pyproject.toml file in the root is the standard

[jsh9]

Sorry about my CI linting problems I can't reproduce this tox environment to check all this problems myself

That's fine. I know what those CI errors are from and I can fix them for you.

What I don't quite know is: as a user, how would I use the new feature that you are adding here.

[Egorrko]

@jsh9
How to use the baseline parameter:
First, you need to generate a baseline file.
Use the --generate-baseline True key, and the --baseline <PATH> key (or add the string baseline ="pydoclint-baseline.txt" to your config file).
After that, your file will be created, and it will contain all the current errors in the project and you will be able to include it in the current CI.
All old errors will be ignored, and any new error will be displayed.
You need to run pydoclint as usual - in check mode.

[Egorrko]

Look at this examples:
https://flakeheaven.readthedocs.io/en/latest/commands/baseline.html
https://github.com/orsinium-labs/mypy-baseline

[jsh9]

@jsh9 How to use the baseline parameter: First, you need to generate a baseline file. Use the --generate-baseline True key, and the --baseline <PATH> key (or add the string baseline ="pydoclint-baseline.txt" to your config file). After that, your file will be created, and it will contain all the current errors in the project and you will be able to include it in the current CI. All old errors will be ignored, and any new error will be displayed. You need to run pydoclint as usual - in check mode.

Thanks!

I'll try it out tomorrow and then I'll write these instructions into README and publish a new version.

[RastaDill]

Yea. Thats cool idea. @jsh9 did you manage to view the instructions?

[jsh9]

Hi @RastaDill and @Egorrko , I haven't had a chance to get to it these past few days -- sorry! Swamped by other things. I'll have a chance to get to it tomrorow.

[Egorrko]

@jsh9 Hello :)
Any news?
Maybe I should edit README.md independently, by analogy with previous PR?

[jsh9]

Hi @Egorrko , sorry I was still too busy to actually test it and write README. If you'd like to contribute to this PR, please feel free to do so. Thank you!

[jsh9]

Hi @Egorrko , thanks so much for adding the documentation. I've read through them and made some tweaks. I just merged the MR and I'll publish the new version now.

[jsh9]

0.3.3 published: https://github.com/jsh9/pydoclint/releases/tag/0.3.3