Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 74cc671

Browse files
authored
Merge pull request gitpython-developers#1735 from EliahKagan/moddoc
Revise and restore some module docstrings
2 parents d5d897c + aed3b59 commit 74cc671

File tree

15 files changed

+21
-13
lines changed

15 files changed

+21
-13
lines changed

‎git/config.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
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-
"""Module containing module parser implementation able to properly read and write
7-
configuration files."""
6+
"""Parser for reading and writing configuration files."""
87

98
import abc
109
import configparser as cp

‎git/exc.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
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-
"""Module containing all exceptions thrown throughout the git package."""
6+
"""Exceptions thrown throughout the git package."""
77

88
__all__ = [
99
# Defined in gitdb.exc:

‎git/index/base.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
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+
"""Module containing IndexFile, an Index implementation facilitating all kinds of index
7+
manipulations such as querying and merging."""
8+
69
from contextlib import ExitStack
710
import datetime
811
import glob

‎git/index/fun.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# This module is part of GitPython and is released under the
22
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
33

4-
# Standalone functions to accompany the index implementation and make it more versatile.
5-
# NOTE: Autodoc hates it if this is a docstring.
4+
"""Standalone functions to accompany the index implementation and make it more versatile."""
65

76
from io import BytesIO
87
import os

‎git/index/typ.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This module is part of GitPython and is released under the
22
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
33

4-
"""Module with additional types used by the index."""
4+
"""Additional types used by the index."""
55

66
from binascii import b2a_hex
77
from pathlib import Path

‎git/index/util.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This module is part of GitPython and is released under the
22
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
33

4-
"""Module containing index utilities."""
4+
"""Index utilities."""
55

66
from functools import wraps
77
import os

‎git/objects/fun.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This module is part of GitPython and is released under the
22
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
33

4-
"""Module with functions which are supposed to be as fast as possible."""
4+
"""Functions that are supposed to be as fast as possible."""
55

66
from stat import S_ISDIR
77

‎git/objects/tag.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
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-
"""Module containing all Object-based types."""
6+
"""Object-based types."""
77

88
from . import base
99
from .util import get_object_type_by_name, parse_actor_and_date

‎git/objects/util.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
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-
"""Module for general utility functions."""
6+
"""General utility functions."""
77

88
# flake8: noqa F401
99

‎git/refs/head.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# This module is part of GitPython and is released under the
22
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
33

4+
"""Some ref-based objects.
5+
6+
Note the distinction between the :class:`HEAD` and :class:`Head` classes.
7+
"""
8+
49
from git.config import GitConfigParser, SectionConstraint
510
from git.util import join_path
611
from git.exc import GitCommandError

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /