Oh boy. This is a lot. we really need to work on that, we can split up the work and start.

Best

On Fri, Jun 13, 2014 at 9:11 PM, Antoine Musso hashar+wmf@free.fr wrote:

Le 13/06/2014 12:47, Ricordisamoa a écrit :

...

You must see this! https://github.com/GreenSteam/pep257 Just run it on our codebase, it gives thousands of errors...

Hello,

multichill on IRC pointed me to your mail. Turns out there is a flake8 extension around pep257:

https://pypi.python.org/pypi/flake8-docstrings/

So I am proposing to add a new tox env 'flake8-docstrings' that runs the pep257 utility and only select errors starting with 'D' (thus ignoring pep8/pyflakes errors).

The pywikibot/core change is:

https://gerrit.wikimedia.org/r/#/c/139412/

The first run is:

https://integration.wikimedia.org/ci/job/pywikibot-core-tox-flake8-docstring...

We can pick a different name :)

The Jenkins and Zuul configurations are straight forward:

https://gerrit.wikimedia.org/r/139417 https://gerrit.wikimedia.org/r/139418

Have a good weekend!

-- Antoine "hashar" Musso

---

Pywikipedia-l mailing list Pywikipedia-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/pywikipedia-l

I will write a script for asap, it'll be fixed by evening

Best

On Sat, Jun 14, 2014 at 10:24 AM, Bináris wikiposta@gmail.com wrote:

Is there a way/tool to automatize a part of this work: I mean

Blank line missing between one-line summary and description

Expected 1 blank line *before* class docstring, found 0

type errors -- this kind may be machine-corrected. Not the missing docstrings, of course.

---

Pywikipedia-l mailing list Pywikipedia-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/pywikipedia-l

On Thu, Oct 30, 2014 at 6:54 AM, John Mark Vandenberg jayvdb@gmail.com wrote:

The entire codebase now passes a mandatory jenkins job (pre-code-review) , which requires valid docstrings except for functions and methods.

Thanks to everyone involved in bringing the documentation up to this standard.

There is still lots to do, like adding docstrings for functions and methods; full list of missing docstrings at:

https://integration.wikimedia.org/ci/job/pywikibot-core-tox-flake8-docstring...

I've started setting up readthedocs

http://pywikibot.readthedocs.org/en/latest/pywikibot.html

It doesnt look great, especially for the scripts due to the fact we use the docstrings in 'help' output (and it isnt formatted for rst), but it is a start

http://pywikibot.readthedocs.org/en/latest/scripts.html#module-scripts.categ...