Skip to content

Commit 231c3ef

Browse files
committed
More docstring revisions within git.repo
1 parent ee0301a commit 231c3ef

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

git/repo/base.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -102,18 +102,17 @@ class BlameEntry(NamedTuple):
102102

103103

104104
class Repo:
105-
"""Represents a git repository and allows you to query references, father
106-
commit information, generate diffs, create and clone repositories, and query the
107-
log.
105+
"""Represents a git repository and allows you to query references, create commit
106+
information, generate diffs, create and clone repositories, and query the log.
108107
109108
The following attributes are worth using:
110109
111110
* :attr:`working_dir` is the working directory of the git command, which is the
112111
working tree directory if available or the ``.git`` directory in case of bare
113112
repositories.
114113
115-
* :attr:`working_tree_dir` is the working tree directory, but will return None if we
116-
are a bare repository.
114+
* :attr:`working_tree_dir` is the working tree directory, but will return ``None``
115+
if we are a bare repository.
117116
118117
* :attr:`git_dir` is the ``.git`` repository directory, which is always set.
119118
"""
@@ -596,7 +595,7 @@ def create_tag(
596595
return TagReference.create(self, path, ref, message, force, **kwargs)
597596

598597
def delete_tag(self, *tags: TagReference) -> None:
599-
"""Delete the given tag references"""
598+
"""Delete the given tag references."""
600599
return TagReference.delete(self, *tags)
601600

602601
def create_remote(self, name: str, url: str, **kwargs: Any) -> Remote:
@@ -775,7 +774,7 @@ def iter_commits(
775774
def merge_base(self, *rev: TBD, **kwargs: Any) -> List[Union[Commit_ish, None]]:
776775
R"""Find the closest common ancestor for the given revision
777776
(:class:`~git.objects.commit.Commit`\s, :class:`~git.refs.tag.Tag`\s,
778-
:class:`git.refs.reference.Reference`\s, etc.).
777+
:class:`~git.refs.reference.Reference`\s, etc.).
779778
780779
:param rev:
781780
At least two revs to find the common ancestor for.
@@ -1030,7 +1029,7 @@ def active_branch(self) -> Head:
10301029
If HEAD is detached.
10311030
10321031
:return:
1033-
Head to the active branch
1032+
:class:`~git.refs.head.Head` to the active branch
10341033
"""
10351034
# reveal_type(self.head.reference) # => Reference
10361035
return self.head.reference

git/repo/fun.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ def name_to_object(
151151
152152
:param return_ref:
153153
If ``True``, and name specifies a reference, we will return the reference
154-
instead of the object. Otherwise it will raise `~gitdb.exc.BadObject` o
154+
instead of the object. Otherwise it will raise `~gitdb.exc.BadObject` or
155155
`~gitdb.exc.BadName`.
156156
"""
157157
hexsha: Union[None, str, bytes] = None

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy