Skip to content

Commit c93e431

Browse files
committed
Expand git.compat docstring
To make clear that code outside GitPython would not typically benefit from using anything in that module. See gitpython-developers#1854 for context.
1 parent a06f1fc commit c93e431

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

git/compat.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,12 @@
33
# This module is part of GitPython and is released under the
44
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
55

6-
"""Utilities to help provide compatibility with Python 3."""
6+
"""Utilities to help provide compatibility with Python 3.
7+
8+
This module exists for historical reasons. Code outside GitPython may make use of public
9+
members of this module, but is unlikely to benefit from doing so. GitPython continues to
10+
use some of these utilities, in some cases for compatibility across different platforms.
11+
"""
712

813
import locale
914
import os

0 commit comments

Comments
 (0)