diff options
| author | Jingjing Duan <jduan@twitter.com> | 2014-06-04 15:54:10 -0700 |
|---|---|---|
| committer | Jingjing Duan <jduan@twitter.com> | 2014-06-04 15:54:10 -0700 |
| commit | cda254d9cd94decc7060c53536de7c8b3dd3429e (patch) | |
| tree | 85d832c4771cfd4047a361e83764348784630109 /jenkinsapi | |
| parent | e4e99bcf07ace4e4c0a6b29d409ef62f0bc93e21 (diff) | |
| download | python-jenkinsapi-cda254d9cd94decc7060c53536de7c8b3dd3429e.tar.gz python-jenkinsapi-cda254d9cd94decc7060c53536de7c8b3dd3429e.tar.bz2 python-jenkinsapi-cda254d9cd94decc7060c53536de7c8b3dd3429e.zip | |
add comment about depth control
Diffstat (limited to 'jenkinsapi')
| -rw-r--r-- | jenkinsapi/build.py | 5 |
1 files changed, 5 insertions, 0 deletions
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 |