Skip to content

Commit

Permalink
Expand git.compat docstring
Browse files Browse the repository at this point in the history
To make clear that code outside GitPython would not typically
benefit from using anything in that module.

See gitpython-developers#1854 for context.
  • Loading branch information
EliahKagan committed Mar 4, 2024
1 parent a06f1fc commit c93e431
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion git/compat.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

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

import locale
import os
Expand Down

0 comments on commit c93e431

Please sign in to comment.