dev-doc: "pydoctor_primer" not documented about pydoctor

[tristanlatr]

Simply put: pydoctor_primer is to pydoctor what mypy_primer is to mypy. It run pydoctor on a corpus of open source code and report in comments when the pydoctor log differs for the changes in a given PR.

[buhtz]

It compares the output of the application before and after a modification in the code (a PR or commit)?

[tristanlatr]

Yep!

[buhtz]

Good test after all other tests failed to find an existing error. Nice.

Just document it somehow. Maybe direct in the yaml file.

[tristanlatr]

If you want to be listen to, quit being so directive and passive aggressive. What about: “let’s put a condition so the pydoctor_primer only runs if the unit tests succeeded?”. This is a general advice, but particularly relevant for messages based communications. Please take that into consideration for futures communications.

[buhtz]

Unfortunately, my English is not good enough for such subtleties. It is not an excuse just an explanation. And I do work on it. Promise.

And I don't see something passive aggressive in my last comment. It really is a nice way to test something. I mean it how I write it.

The issue is not about running or not running the primer. From the viewpoint of extern contributors it would be helpful if they would be enabled to understand what it is.