[Reportbug-maint] Bug#890680: Bug#890680: reportbug: python3-reportbug submodules are not well documented

[Sandro Tosi]

Hey Nis!

> The reportbug source code has some issues that make it hard to review:


thanks for working on this! even if i dont want to mess with your
plans, let me tell you that if you really want to work on this "qa"
kind-of activity for reportbug, i think the area that will give the
biggest impact is improvements to the test suite: currently part of
the code is not covered well (or at all) and i did a poor job at
adding tests for bugs that were filed and fixed; also i've always
wished to be able to test the interactive part in reportbug (maybe
mocking the input method).

>  - Most functions in reportbug/*.py do not have a docstring, or only a very
>    brief one. Some functions still have many parameters, and some return quite
>    complex objects.
>  - module-internal functions are not prefixed with an underscore, so it is hard
>    to tell which functions are meant for external use.

can we do something now, though? as of now they are all public
functions, removing them by making them private can break someone's
code (ok ok it's rather remote possibility but still)

> I'm slowly working on patches.

i would suggest to submit of your early patches soon, so that i can
have a look and eventually comment earlier

Thanks as usual,
-- 
Sandro "morph" Tosi
My website: http://sandrotosi.me/
Me at Debian: http://wiki.debian.org/SandroTosi
G+: https://plus.google.com/u/0/+SandroTosi