From 177a468335ffc900d7ca36408b1c3985b7b5155b Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 28 Jul 2020 12:59:24 +0200 Subject: [PATCH] docs: tweak inline docstring about depth traitlet --- nbgitpuller/pull.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/nbgitpuller/pull.py b/nbgitpuller/pull.py index 0bb388ac..a2ea4fad 100644 --- a/nbgitpuller/pull.py +++ b/nbgitpuller/pull.py @@ -49,13 +49,12 @@ class GitPuller(Configurable): depth = Integer( config=True, help=""" - Depth (ie, commit count) to which to perform a - shallow git clone. + Depth (ie, commit count) of clone operations. Set this to 0 to make a + full depth clone. - If not set, clones to depth 1. - - Defaults to reading from the NBGITPULLER_DEPTH - environment variable.""" + Defaults to the value of the environment variable NBGITPULLER_DEPTH, or + 1 if the the environment variable isn't set. + """ ) @default('depth')