add comment about depth control

diff --git a/jenkinsapi/build.py b/jenkinsapi/build.py
index 781370fb572f870a6f9b95ee3e8762033c1ecbce..da04fd83b563b7c575e7e1a9182726f63254a992 100644 (file)
--- 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