From: Jingjing Duan <jduan@twitter.com>
Date: Wed, 4 Jun 2014 22:54:10 +0000 (-0700)
Subject: add comment about depth control
X-Git-Tag: v0.2.23~15^2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=cda254d9cd94decc7060c53536de7c8b3dd3429e;p=tools%2Fpython-jenkinsapi.git

add comment about depth control
---

diff --git a/jenkinsapi/build.py b/jenkinsapi/build.py
index 781370f..da04fd8 100644
--- a/jenkinsapi/build.py
+++ b/jenkinsapi/build.py
@@ -37,6 +37,11 @@ class Build(JenkinsBase):
     def __init__(self, url, buildno, job, depth=1):
         """
         depth=1 is for backward compatibility consideration
+
+        About depth, the deeper it is, the more build data you get back. If
+        depth=0 is sufficient for you, don't go up to 1. See section 'Depth
+        control' of
+        https://wiki.jenkins-ci.org/display/JENKINS/Remote+access+API
         """
         assert type(buildno) == int
         self.buildno = buildno