Skip to content

Commit

Permalink
Merge pull request #1735 from EliahKagan/moddoc
Browse files Browse the repository at this point in the history
Revise and restore some module docstrings
  • Loading branch information
Byron authored Nov 6, 2023
2 parents d5d897c + aed3b59 commit 74cc671
Show file tree
Hide file tree
Showing 15 changed files with 21 additions and 13 deletions.
3 changes: 1 addition & 2 deletions git/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Module containing module parser implementation able to properly read and write
configuration files."""
"""Parser for reading and writing configuration files."""

import abc
import configparser as cp
Expand Down
2 changes: 1 addition & 1 deletion git/exc.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Module containing all exceptions thrown throughout the git package."""
"""Exceptions thrown throughout the git package."""

__all__ = [
# Defined in gitdb.exc:
Expand Down
3 changes: 3 additions & 0 deletions git/index/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Module containing IndexFile, an Index implementation facilitating all kinds of index
manipulations such as querying and merging."""

from contextlib import ExitStack
import datetime
import glob
Expand Down
3 changes: 1 addition & 2 deletions git/index/fun.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

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

from io import BytesIO
import os
Expand Down
2 changes: 1 addition & 1 deletion git/index/typ.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Module with additional types used by the index."""
"""Additional types used by the index."""

from binascii import b2a_hex
from pathlib import Path
Expand Down
2 changes: 1 addition & 1 deletion git/index/util.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Module containing index utilities."""
"""Index utilities."""

from functools import wraps
import os
Expand Down
2 changes: 1 addition & 1 deletion git/objects/fun.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Module with functions which are supposed to be as fast as possible."""
"""Functions that are supposed to be as fast as possible."""

from stat import S_ISDIR

Expand Down
2 changes: 1 addition & 1 deletion git/objects/tag.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Module containing all Object-based types."""
"""Object-based types."""

from . import base
from .util import get_object_type_by_name, parse_actor_and_date
Expand Down
2 changes: 1 addition & 1 deletion git/objects/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Module for general utility functions."""
"""General utility functions."""

# flake8: noqa F401

Expand Down
5 changes: 5 additions & 0 deletions git/refs/head.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Some ref-based objects.
Note the distinction between the :class:`HEAD` and :class:`Head` classes.
"""

from git.config import GitConfigParser, SectionConstraint
from git.util import join_path
from git.exc import GitCommandError
Expand Down
2 changes: 2 additions & 0 deletions git/refs/remote.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Module implementing a remote object allowing easy access to git remotes."""

import os

from git.util import join_path
Expand Down
2 changes: 1 addition & 1 deletion git/repo/fun.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Module with general repository-related functions."""
"""General repository-related functions."""

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion test/test_blob_filter.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Test the blob filter."""
"""Tests for the blob filter."""

from pathlib import Path
from typing import Sequence, Tuple
Expand Down
1 change: 0 additions & 1 deletion test/test_exc.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/


import re

import ddt
Expand Down
1 change: 1 addition & 0 deletions test/test_repo.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
#
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

import glob
import io
from io import BytesIO
Expand Down

0 comments on commit 74cc671

Please sign in to comment.