| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 4bedb05 commit 3d979a6
4 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -508,7 +508,7 @@ def iter_blobs( | |||
| 508 | 508 | ||
| 509 | 509 | :param predicate: | |
| 510 | 510 | 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 | ||
| 512 | 512 | to yield blobs only if they match a given list of paths. | |
| 513 | 513 | """ | |
| 514 | 514 | for entry in self.entries.values(): | |
@@ -770,7 +770,7 @@ def add( | |||
| 770 | 770 | - path string | |
| 771 | 771 | ||
| 772 | 772 | 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``, | ||
| 774 | 774 | ``/home/gitrepo/lib/myfile.ext``. | |
| 775 | 775 | ||
| 776 | 776 | Absolute paths must start with working tree directory of this index's | |
@@ -789,7 +789,7 @@ def add( | |||
| 789 | 789 | ||
| 790 | 790 | They are added at stage 0. | |
| 791 | 791 | ||
| 792 | - - :class:~`git.objects.blob.Blob` or | ||
| 792 | + - :class:`~git.objects.blob.Blob` or | ||
| 793 | 793 | :class:`~git.objects.submodule.base.Submodule` object | |
| 794 | 794 | ||
| 795 | 795 | Blobs are added as they are assuming a valid mode is set. | |
@@ -815,7 +815,7 @@ def add( | |||
| 815 | 815 | ||
| 816 | 816 | - :class:`~git.index.typ.BaseIndexEntry` or type | |
| 817 | 817 | ||
| 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 | ||
| 819 | 819 | the stage may be explicitly set. Please note that Index Entries require | |
| 820 | 820 | binary sha's. | |
| 821 | 821 | ||
@@ -998,7 +998,7 @@ def remove( | |||
| 998 | 998 | ||
| 999 | 999 | The path string may include globs, such as ``*.c``. | |
| 1000 | 1000 | ||
| 1001 | - - :class:~`git.objects.blob.Blob` object | ||
| 1001 | + - :class:`~git.objects.blob.Blob` object | ||
| 1002 | 1002 | ||
| 1003 | 1003 | Only the path portion is used in this case. | |
| 1004 | 1004 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -122,7 +122,7 @@ def new(cls, repo: "Repo", id: Union[str, "Reference"]) -> AnyGitObject: | |||
| 122 | 122 | :return: | |
| 123 | 123 | New :class:`Object` instance of a type appropriate to the object type behind | |
| 124 | 124 | `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. | ||
| 126 | 126 | ||
| 127 | 127 | :param id: | |
| 128 | 128 | :class:`~git.refs.reference.Reference`, rev-spec, or hexsha. | |
@@ -218,7 +218,7 @@ class IndexObject(Object): | |||
| 218 | 218 | """Base for all objects that can be part of the index file. | |
| 219 | 219 | ||
| 220 | 220 | 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, | ||
| 222 | 222 | :class:`~git.objects.submodule.base.Submodule`, which is not really a git object | |
| 223 | 223 | type but can be part of an index file, is also a subclass. | |
| 224 | 224 | """ | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -289,7 +289,7 @@ def name_rev(self) -> str: | |||
| 289 | 289 | """ | |
| 290 | 290 | :return: | |
| 291 | 291 | String describing the commits hex sha based on the closest | |
| 292 | - `~git.refs.reference.Reference`. | ||
| 292 | + :class:`~git.refs.reference.Reference`. | ||
| 293 | 293 | ||
| 294 | 294 | :note: | |
| 295 | 295 | Mostly useful for UI purposes. | |
@@ -349,7 +349,7 @@ def iter_items( | |||
| 349 | 349 | return cls._iter_from_process_or_stream(repo, proc) | |
| 350 | 350 | ||
| 351 | 351 | def iter_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. | ||
| 353 | 353 | ||
| 354 | 354 | :param paths: | |
| 355 | 355 | Optional path or list of paths limiting the :class:`Commit`\s to those that | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -512,7 +512,7 @@ def create_submodule(self, *args: Any, **kwargs: Any) -> Submodule: | |||
| 512 | 512 | def iter_submodules(self, *args: Any, **kwargs: Any) -> Iterator[Submodule]: | |
| 513 | 513 | """An iterator yielding Submodule instances. | |
| 514 | 514 | ||
| 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` | ||
| 516 | 516 | and `kwargs`. | |
| 517 | 517 | ||
| 518 | 518 | :return: | |
| Back | FazBrowse Home | New Git URL |
0 commit comments