Skip to content

Commit cf237db

Browse files
paredByron
authored andcommitted
git: repo: base: update clone_from env argument description
1 parent 66bb013 commit cf237db

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

git/repo/base.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1012,6 +1012,11 @@ def clone_from(cls, url, to_path, progress=None, env=None, multi_options=None, *
10121012
:param to_path: Path to which the repository should be cloned to
10131013
:param progress: See 'git.remote.Remote.push'.
10141014
:param env: Optional dictionary containing the desired environment variables.
1015+
Note: Provided variables will be used to update the execution
1016+
environment for `git`. If some variable is not specified in `env`
1017+
and is defined in `os.environ`, value from `os.environ` will be used.
1018+
If you want to unset some variable, consider providing empty string
1019+
as its value.
10151020
:param multi_options: See ``clone`` method
10161021
:param kwargs: see the ``clone`` method
10171022
:return: Repo instance pointing to the cloned directory"""

0 commit comments

Comments
 (0)