Skip to content

Navigation Menu

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

Appearance settings

Commit 74cc671

Browse filesBrowse files
authored
Merge pull request #1735 from EliahKagan/moddoc
Revise and restore some module docstrings
2 parents d5d897c + aed3b59 commit 74cc671
Copy full SHA for 74cc671

File tree

15 files changed

+21
-13
lines changed
Filter options

15 files changed

+21
-13
lines changed

‎git/config.py

Copy file name to clipboardExpand all lines: git/config.py
+1-2Lines 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

Copy file name to clipboardExpand all lines: git/exc.py
+1-1Lines 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

Copy file name to clipboardExpand all lines: git/index/base.py
+3Lines 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

Copy file name to clipboardExpand all lines: git/index/fun.py
+1-2Lines 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

Copy file name to clipboardExpand all lines: git/index/typ.py
+1-1Lines 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

Copy file name to clipboardExpand all lines: git/index/util.py
+1-1Lines 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

Copy file name to clipboardExpand all lines: git/objects/fun.py
+1-1Lines 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

Copy file name to clipboardExpand all lines: git/objects/tag.py
+1-1Lines 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

Copy file name to clipboardExpand all lines: git/objects/util.py
+1-1Lines 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

Copy file name to clipboardExpand all lines: git/refs/head.py
+5Lines 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

‎git/refs/remote.py

Copy file name to clipboardExpand all lines: git/refs/remote.py
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
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 implementing a remote object allowing easy access to git remotes."""
5+
46
import os
57

68
from git.util import join_path

‎git/repo/fun.py

Copy file name to clipboardExpand all lines: git/repo/fun.py
+1-1Lines 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 general repository-related functions."""
4+
"""General repository-related functions."""
55

66
from __future__ import annotations
77

‎test/test_blob_filter.py

Copy file name to clipboardExpand all lines: test/test_blob_filter.py
+1-1Lines 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-
"""Test the blob filter."""
4+
"""Tests for the blob filter."""
55

66
from pathlib import Path
77
from typing import Sequence, Tuple

‎test/test_exc.py

Copy file name to clipboardExpand all lines: test/test_exc.py
-1Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
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-
76
import re
87

98
import ddt

‎test/test_repo.py

Copy file name to clipboardExpand all lines: test/test_repo.py
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
#
33
# This module is part of GitPython and is released under the
44
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
5+
56
import glob
67
import io
78
from io import BytesIO

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.