From 85d017d1e8ac4b86ece84a5ea44720d295d1dd61 Mon Sep 17 00:00:00 2001 From: Emily Morehouse Date: Mon, 22 May 2017 16:10:26 -0700 Subject: [PATCH] Documentation updates for testing information (#1293) - Removes references to 'runtests.sh', as it has been removed - Adds links from the contributing file to the readme - testing section - Updates flake8 stats --- .flake8 | 22 +++++++++++----------- CONTRIBUTING.md | 8 ++++---- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.flake8 b/.flake8 index df2f9caf8..ba7abd11f 100644 --- a/.flake8 +++ b/.flake8 @@ -1,17 +1,17 @@ # Some PEP8 deviations are considered irrelevant to stub files: -# (error counts as of 2016-12-19) -# 17381 E704 multiple statements on one line (def) -# 11840 E301 expected 1 blank line -# 7467 E302 expected 2 blank lines -# 1772 E501 line too long -# 1487 F401 imported but unused -# 1248 E701 multiple statements on one line (colon) -# 427 F811 redefinition -# 356 E305 expected 2 blank lines +# (error counts as of 2017-05-22) +# 17952 E704 multiple statements on one line (def) +# 12197 E301 expected 1 blank line +# 7155 E302 expected 2 blank lines +# 2307 E501 line too long +# 1463 F401 imported but unused +# 967 E701 multiple statements on one line (colon) +# 457 F811 redefinition +# 390 E305 expected 2 blank lines # Nice-to-haves ignored for now -# 152 E128 continuation line under-indented for visual indent -# 43 E127 continuation line over-indented for visual indent +# 159 E128 continuation line under-indented for visual indent +# 34 E127 continuation line over-indented for visual indent [flake8] ignore = F401, F811, E127, E128, E301, E302, E305, E501, E701, E704, B303 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c95d2783..f7dba1946 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,12 +9,12 @@ are important to the project's success. ## The contribution process at a glance 1. Read the [README.md file](README.md). -2. Set up your environment to be able to run all tests with `runtests.sh`. They should pass. +2. Set up your environment to be able to [run all tests](README.md#running-the-tests). They should pass. 3. [Prepare your changes](#preparing-changes): * [Contact us](#discussion) before starting significant work. * IMPORTANT: For new libraries, [get permission from the library owner first](#adding-a-new-library). * Create your stubs [conforming to the coding style](#stub-file-coding-style). - * Make sure `runtests.sh` passes cleanly on Mypy, pytype, and flake8. + * Make sure your tests pass cleanly on `mypy`, `pytype`, and `flake8`. 4. [Submit your changes](#submitting-changes): * Open a pull request * For new libraries, [include a reference to where you got permission](#adding-a-new-library) @@ -103,8 +103,8 @@ should prefer to external type stubs). When the project owners agree for you to submit stubs here, open a pull request **referencing the message where you received permission**. -Make sure your changes pass tests by running ``runtests.sh`` (the -[README](README.md) has more information). +Make sure your changes pass the tests (the [README](README.md#running-the-tests) +has more information). ### Using stubgen