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

Commit110706e

Browse files
committed
Fix param name in TagRefernece docstring and add info
The "reference" parameter was listed as "ref" in the docstring.This fixes that, slightly expands its description, and also addsdocumentation for the "repo" parameter.
1 parent6126997 commit110706e

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

‎git/refs/tag.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,8 @@ def commit(self) -> "Commit": # type: ignore[override] # LazyMixin has unrelat
7272
deftag(self)->Union["TagObject",None]:
7373
"""
7474
:return:
75-
Tag object this tag ref points to or None in case we are a lightweight tag
75+
Tag object this tag ref points to, or ``None`` in case we are a lightweight
76+
tag
7677
"""
7778
obj=self.object
7879
ifobj.type=="tag":
@@ -96,13 +97,17 @@ def create(
9697
)->"TagReference":
9798
"""Create a new tag reference.
9899
100+
:param repo:
101+
The :class:`~git.repo.base.Repo` to create the tag in.
102+
99103
:param path:
100104
The name of the tag, e.g. ``1.0`` or ``releases/1.0``.
101105
The prefix ``refs/tags`` is implied.
102106
103-
:paramref:
107+
:paramreference:
104108
A reference to the :class:`~git.objects.base.Object` you want to tag.
105-
The Object can be a commit, tree or blob.
109+
The referenced object can be a :class:`~git.objects.commit.Commit`,
110+
:class:`~git.objects.tree.Tree`, or :class:`~git.objects.blob.Blob`.
106111
107112
:param logmsg:
108113
If not None, the message will be used in your tag object. This will also

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp