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

Commit0f18290

Browse files
authored
Merge pull request#2018 from koyuki7w/patch-1
Fix some incorrect sphinx markups in the docstrings
2 parents4bedb05 +3d979a6 commit0f18290

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

‎git/index/base.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ def iter_blobs(
508508
509509
:param predicate:
510510
Function(t) returning ``True`` if tuple(stage, Blob) should be yielded by
511-
the iterator. A default filter, the `~git.index.typ.BlobFilter`, allows you
511+
the iterator. A default filter, the:class:`~git.index.typ.BlobFilter`, allows you
512512
to yield blobs only if they match a given list of paths.
513513
"""
514514
forentryinself.entries.values():
@@ -770,7 +770,7 @@ def add(
770770
- path string
771771
772772
Strings denote a relative or absolute path into the repository pointing
773-
to an existing file, e.g., ``CHANGES``, `lib/myfile.ext``,
773+
to an existing file, e.g., ``CHANGES``, ``lib/myfile.ext``,
774774
``/home/gitrepo/lib/myfile.ext``.
775775
776776
Absolute paths must start with working tree directory of this index's
@@ -789,7 +789,7 @@ def add(
789789
790790
They are added at stage 0.
791791
792-
- :class:~`git.objects.blob.Blob` or
792+
- :class:`~git.objects.blob.Blob` or
793793
:class:`~git.objects.submodule.base.Submodule` object
794794
795795
Blobs are added as they are assuming a valid mode is set.
@@ -815,7 +815,7 @@ def add(
815815
816816
- :class:`~git.index.typ.BaseIndexEntry` or type
817817
818-
Handling equals the one of :class:~`git.objects.blob.Blob` objects, but
818+
Handling equals the one of :class:`~git.objects.blob.Blob` objects, but
819819
the stage may be explicitly set. Please note that Index Entries require
820820
binary sha's.
821821
@@ -998,7 +998,7 @@ def remove(
998998
999999
The path string may include globs, such as ``*.c``.
10001000
1001-
- :class:~`git.objects.blob.Blob` object
1001+
- :class:`~git.objects.blob.Blob` object
10021002
10031003
Only the path portion is used in this case.
10041004

‎git/objects/base.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ def new(cls, repo: "Repo", id: Union[str, "Reference"]) -> AnyGitObject:
122122
:return:
123123
New :class:`Object` instance of a type appropriate to the object type behind
124124
`id`. The id of the newly created object will be a binsha even though the
125-
input id may have been a `~git.refs.reference.Reference` or rev-spec.
125+
input id may have been a:class:`~git.refs.reference.Reference` or rev-spec.
126126
127127
:param id:
128128
:class:`~git.refs.reference.Reference`, rev-spec, or hexsha.
@@ -218,7 +218,7 @@ class IndexObject(Object):
218218
"""Base for all objects that can be part of the index file.
219219
220220
The classes representing git object types that can be part of the index file are
221-
:class:`~git.objects.tree.Tree and :class:`~git.objects.blob.Blob`. In addition,
221+
:class:`~git.objects.tree.Tree` and :class:`~git.objects.blob.Blob`. In addition,
222222
:class:`~git.objects.submodule.base.Submodule`, which is not really a git object
223223
type but can be part of an index file, is also a subclass.
224224
"""

‎git/objects/commit.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ def name_rev(self) -> str:
289289
"""
290290
:return:
291291
String describing the commits hex sha based on the closest
292-
`~git.refs.reference.Reference`.
292+
:class:`~git.refs.reference.Reference`.
293293
294294
:note:
295295
Mostly useful for UI purposes.
@@ -349,7 +349,7 @@ def iter_items(
349349
returncls._iter_from_process_or_stream(repo,proc)
350350

351351
defiter_parents(self,paths:Union[PathLike,Sequence[PathLike]]="",**kwargs:Any)->Iterator["Commit"]:
352-
R"""Iterate_all_ parents of this commit.
352+
R"""Iterate*all* parents of this commit.
353353
354354
:param paths:
355355
Optional path or list of paths limiting the :class:`Commit`\s to those that

‎git/repo/base.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ def create_submodule(self, *args: Any, **kwargs: Any) -> Submodule:
512512
defiter_submodules(self,*args:Any,**kwargs:Any)->Iterator[Submodule]:
513513
"""An iterator yielding Submodule instances.
514514
515-
See the `~git.objects.util.Traversable` interface for a description of `args`
515+
See the:class:`~git.objects.util.Traversable` interface for a description of `args`
516516
and `kwargs`.
517517
518518
:return:

0 commit comments

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