summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKien Ha <kienha9922@gmail.com>2016-07-29 01:57:04 -0400
committerKien Ha <kienha9922@gmail.com>2016-07-29 01:57:04 -0400
commitca1d5abed4520452ca6e5e79e65ef71386d961c6 (patch)
treea55ea7f19e98ffcb0d5ac645dad961c881e2895c
parenta88104422e80a3d3fafb48360411fafffe46e86b (diff)
downloadpython-jenkins-job-builder-ca1d5abed4520452ca6e5e79e65ef71386d961c6.tar.gz
python-jenkins-job-builder-ca1d5abed4520452ca6e5e79e65ef71386d961c6.tar.xz
python-jenkins-job-builder-ca1d5abed4520452ca6e5e79e65ef71386d961c6.zip
Update FindBugs docs to 4 space indent syntax
Change-Id: Id31c8214c1c2610f24d51a7089604604a21dc42b Signed-off-by: Kien Ha <kienha9922@gmail.com>
-rw-r--r--jenkins_jobs/modules/publishers.py24
-rw-r--r--jenkins_jobs/modules/reporters.py19
2 files changed, 20 insertions, 23 deletions
diff --git a/jenkins_jobs/modules/publishers.py b/jenkins_jobs/modules/publishers.py
index c3148f75..638fd87b 100644
--- a/jenkins_jobs/modules/publishers.py
+++ b/jenkins_jobs/modules/publishers.py
@@ -1401,31 +1401,29 @@ def findbugs(parser, xml_parent, data):
<FindBugs+Plugin>`.
:arg str pattern: specifies the generated raw FindBugs XML report files,
- such as \*\*/findbugs.xml or \*\*/findbugsXml.xml.
- (default '')
+ such as \*\*/findbugs.xml or \*\*/findbugsXml.xml. (default '')
:arg bool rank-priority: Use rank as priority (default false)
:arg str include-files: Comma separated list of files to include.
- (default '')
+ (default '')
:arg str exclude-files: Comma separated list of files to exclude.
- (default '')
+ (default '')
:arg bool can-run-on-failed: Weather or not to run plug-in on failed builds
- (default false)
+ (default false)
:arg bool should-detect-modules: Determines if Ant or Maven modules should
- be detected for all files that contain
- warnings. (default false)
+ be detected for all files that contain warnings. (default false)
:arg int healthy: Sunny threshold (default '')
:arg int unhealthy: Stormy threshold (default '')
:arg str health-threshold: Threshold priority for health status
- ('low', 'normal' or 'high', defaulted to 'low')
+ ('low', 'normal' or 'high', defaulted to 'low')
:arg bool dont-compute-new: If set to false, computes new warnings based on
- the reference build (default true)
+ the reference build (default true)
:arg bool use-delta-values: Use delta for new warnings. (default false)
:arg bool use-previous-build-as-reference: If set then the number of new
- warnings will always be calculated based on the previous build. Otherwise
- the reference build. (default false)
+ warnings will always be calculated based on the previous build.
+ Otherwise the reference build. (default false)
:arg bool use-stable-build-as-reference: The number of new warnings will be
- calculated based on the last stable build, allowing reverts of unstable
- builds where the number of warnings was decreased. (default false)
+ calculated based on the last stable build, allowing reverts of unstable
+ builds where the number of warnings was decreased. (default false)
:arg dict thresholds:
:thresholds:
* **unstable** (`dict`)
diff --git a/jenkins_jobs/modules/reporters.py b/jenkins_jobs/modules/reporters.py
index 068c43e3..5daabd44 100644
--- a/jenkins_jobs/modules/reporters.py
+++ b/jenkins_jobs/modules/reporters.py
@@ -80,24 +80,24 @@ def findbugs(parser, xml_parent, data):
:arg bool rank-priority: Use rank as priority (default false)
:arg str include-files: Comma separated list of files to include.
- (Optional)
+ (Optional)
:arg str exclude-files: Comma separated list of files to exclude.
- (Optional)
+ (Optional)
:arg bool can-run-on-failed: Weather or not to run plug-in on failed builds
- (default false)
+ (default false)
:arg int healthy: Sunny threshold (optional)
:arg int unhealthy: Stormy threshold (optional)
:arg str health-threshold: Threshold priority for health status
- ('low', 'normal' or 'high', defaulted to 'low')
+ ('low', 'normal' or 'high', defaulted to 'low')
:arg bool dont-compute-new: If set to false, computes new warnings based on
- the reference build (default true)
+ the reference build (default true)
:arg bool use-delta-values: Use delta for new warnings. (default false)
:arg bool use-previous-build-as-reference: If set then the number of new
- warnings will always be calculated based on the previous build. Otherwise
- the reference build. (default false)
+ warnings will always be calculated based on the previous build.
+ Otherwise the reference build. (default false)
:arg bool use-stable-build-as-reference: The number of new warnings will be
- calculated based on the last stable build, allowing reverts of unstable
- builds where the number of warnings was decreased. (default false)
+ calculated based on the last stable build, allowing reverts of unstable
+ builds where the number of warnings was decreased. (default false)
:arg dict thresholds:
:thresholds:
* **unstable** (`dict`)
@@ -127,7 +127,6 @@ def findbugs(parser, xml_parent, data):
Full Example:
.. literalinclude:: /../../tests/reporters/fixtures/findbugs01.yaml
-
"""
findbugs = XML.SubElement(xml_parent,
'hudson.plugins.findbugs.FindBugsReporter')