Movatterモバイル変換

[0]ホーム
URL:

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

Revise and restore some module docstrings#1735

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
Byron merged 1 commit intogitpython-developers:mainfromEliahKagan:moddoc
Nov 6, 2023
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletionsgit/config.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletiongit/exc.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletionsgit/index/base.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletionsgit/index/fun.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletiongit/index/typ.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletiongit/index/util.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletiongit/objects/fun.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletiongit/objects/tag.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 allObject-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 deletiongit/objects/util.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletionsgit/refs/head.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletionsgit/refs/remote.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletiongit/repo/fun.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletiontest/test_blob_filter.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletiontest/test_exc.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletionstest/test_repo.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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
[8]ページ先頭
©2009-2025 Movatter.jp