From 4396a3f62d6a34ba803cadec193222e5aa9cd32c Mon Sep 17 00:00:00 2001 From: Ben Patterson Date: Thu, 16 Oct 2014 08:22:02 -0400 Subject: [PATCH 1/2] Doc for paver quality switches. --- docs/en_us/internal/testing.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/en_us/internal/testing.md b/docs/en_us/internal/testing.md index 30b32a8663..2d7d78d9ae 100644 --- a/docs/en_us/internal/testing.md +++ b/docs/en_us/internal/testing.md @@ -385,10 +385,26 @@ generates HTML and XML (Cobertura format) reports. ## Code Style Quality -To view code style quality (e.g. pep8 and pylint violations): +To view code style quality (including pep8 and pylint violations): paver run_quality +More specific options are below. + +* Running a particular quality report: + + paver run_pep8 + paver run_pylint + +* Running a report, and setting it to fail if it exceeds a given number of violations: + + paver run_pep8 -l 800 + +* The `run_quality` uses the underlying diff-quality tool (which is packaged with [diff-cover](https://github.com/edx/diff-cover)). With that, the command can be set to fail if a certain diff threshold is not met. For example, to cause the process to fail if quality expectations are less than 100% when compared to master (or in other words, if style quality is worse than what's already on master): + + paver run_quality -p 100 + + ## Testing using queue servers From b8807e8163c435759394ec0e6edf56389037f18c Mon Sep 17 00:00:00 2001 From: Ben Patterson Date: Thu, 16 Oct 2014 17:04:15 -0400 Subject: [PATCH 2/2] Clarify swtiches on paver tasks. --- docs/en_us/internal/testing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en_us/internal/testing.md b/docs/en_us/internal/testing.md index 2d7d78d9ae..a278186a7f 100644 --- a/docs/en_us/internal/testing.md +++ b/docs/en_us/internal/testing.md @@ -398,11 +398,11 @@ More specific options are below. * Running a report, and setting it to fail if it exceeds a given number of violations: - paver run_pep8 -l 800 + paver run_pep8 --limit=800 * The `run_quality` uses the underlying diff-quality tool (which is packaged with [diff-cover](https://github.com/edx/diff-cover)). With that, the command can be set to fail if a certain diff threshold is not met. For example, to cause the process to fail if quality expectations are less than 100% when compared to master (or in other words, if style quality is worse than what's already on master): - paver run_quality -p 100 + paver run_quality --percentage=100