From 000813f1b57c40142755fd0037c4cb7e0ad64eb1 Mon Sep 17 00:00:00 2001 From: Giovanni Lanzani Date: Wed, 10 Jun 2020 15:44:51 +0200 Subject: [PATCH 1/3] DOC Add note about shallow clones --- doc/source/development/contributing.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 163d345b4f829..7bc1fe728999f 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -136,6 +136,9 @@ want to clone your fork to your machine:: This creates the directory `pandas-yourname` and connects your repository to the upstream (main project) *pandas* repository. +Note that performing a shallow clone (with `--depth==N`, for some `N` greater +or equal to 1) might break some tests and features as `pd.show_versions()`. + .. _contributing.dev_env: Creating a development environment From c780d7dc5e657650447d873fdf840d75ef48badd Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Wed, 10 Jun 2020 16:52:26 +0200 Subject: [PATCH 2/3] Update doc/source/development/contributing.rst Co-authored-by: Uwe L. Korn --- doc/source/development/contributing.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 7bc1fe728999f..6dd12f32322e8 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -137,7 +137,8 @@ This creates the directory `pandas-yourname` and connects your repository to the upstream (main project) *pandas* repository. Note that performing a shallow clone (with `--depth==N`, for some `N` greater -or equal to 1) might break some tests and features as `pd.show_versions()`. +or equal to 1) might break some tests and features as `pd.show_versions()` +as the version number cannot be computed anymore. .. _contributing.dev_env: From b04d4decac56b127d2c0bfcd8bf278594b30ef8e Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Wed, 10 Jun 2020 16:53:25 +0200 Subject: [PATCH 3/3] Update doc/source/development/contributing.rst --- doc/source/development/contributing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 6dd12f32322e8..b85e9403038ab 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -136,8 +136,8 @@ want to clone your fork to your machine:: This creates the directory `pandas-yourname` and connects your repository to the upstream (main project) *pandas* repository. -Note that performing a shallow clone (with `--depth==N`, for some `N` greater -or equal to 1) might break some tests and features as `pd.show_versions()` +Note that performing a shallow clone (with ``--depth==N``, for some ``N`` greater +or equal to 1) might break some tests and features as ``pd.show_versions()`` as the version number cannot be computed anymore. .. _contributing.dev_env: