mirror of
https://github.com/galaxyproject/galaxy.git
synced 2026-09-21 22:06:53 +08:00
John Chilton
56721e7a0f
- 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.
16 lines
885 B
INI
16 lines
885 B
INI
[flake8]
|
|
# These are exceptions allowed by Galaxy style guidelines.
|
|
# 128 continuation line under-indented for visual indent
|
|
# 201 and 202 are spaces after ( and before )
|
|
# 203 whitespace before ':'
|
|
# 402 module level import not at top of file # TODO, we would like to improve this.
|
|
# 501 is line length
|
|
# W503 is line breaks before binary operators, which has been reversed in PEP 8.
|
|
# D** are docstring linting - which we mostly ignore except D302. (Hopefully we will solve more over time).
|
|
ignore = E128,E201,E202,E203,E501,E402,W503,D100,D101,D102,D103,D104,D105,D200,D201,D202,D204,D205,D206,D207,D208,D209,D210,D211,D300,D301,D400,D401,D402,D403
|
|
exclude = lib/galaxy/util/jstree.py
|
|
# For flake8-import-order
|
|
# https://github.com/PyCQA/flake8-import-order/blob/master/tests/test_cases/complete_smarkets.py
|
|
import-order-style = smarkets
|
|
application-import-names = galaxy,tool_shed
|