Branch: refs/heads/dev Home: https://github.com/galaxyproject/galaxy Commit: 56721e7a0fe67e9aba55d4b52d97601b75b2beb9 https://github.com/galaxyproject/galaxy/commit/56721e7a0fe67e9aba55d4b52d976... Author: John Chilton jmchilton@gmail.com Date: 2016-10-04 (Tue, 04 Oct 2016)
Changed paths: A .ci/flake8_docstrings_include_list.txt M .ci/flake8_wrapper.sh A .ci/flake8_wrapper_docstrings.sh M .travis.yml M lib/galaxy/util/__init__.py M setup.cfg M tox.ini
Log Message: ----------- Initial docstring linting.
- Apply one docstring lint to the global lint list (D302 - unicode docstrings should start with u"""). - Create an inclusion list with many more docstring checks (public modules need a docstring, white space and quoting issue, check imperative mood and capitializaton). Add a couple modules to this inclusion list. - Add tox and Travis targets for this linting.
This gives a person who wants to work on improving Galaxy's in-code docstring documentation three ways to "raise the bar" for the project. One could: - Add more modules to the inclusion list (.ci/flake8_docstrings_include_list.txt). Many more modules should contain docstrings - especially things in galaxy-lib and web controllers. - Add more checks to the existing inclusion list checks - I'd say D101 and/or D103 first or any of the missing D2XX or D4XX options. D102 seems a bit too ambitious and I worry it'd be too much of a burden. - Pick some DXXX check that is ignored globally and fix it for the whole project and then remove it from the exclude list in setup.cfg.
Commit: 9ae35cb64a57a67976459de1a9c589f3b70ab3f1 https://github.com/galaxyproject/galaxy/commit/9ae35cb64a57a67976459de1a9c58... Author: John Chilton jmchilton@gmail.com Date: 2016-10-05 (Wed, 05 Oct 2016)
Changed paths: M tox.ini
Log Message: ----------- Fix typo spotted by @nsoranzo.
Commit: 51aa341fe5ac7859233081af3ce5fab934349b1c https://github.com/galaxyproject/galaxy/commit/51aa341fe5ac7859233081af3ce5f... Author: Martin Cech cech.marten@gmail.com Date: 2016-10-06 (Thu, 06 Oct 2016)
Changed paths: A .ci/flake8_docstrings_include_list.txt M .ci/flake8_wrapper.sh A .ci/flake8_wrapper_docstrings.sh M .travis.yml M lib/galaxy/util/__init__.py M setup.cfg M tox.ini
Log Message: ----------- Merge pull request #3004 from jmchilton/docstring_lint
Initial docstring linting.
Compare: https://github.com/galaxyproject/galaxy/compare/59a6d07b7b02...51aa341fe5ac