|
126 | 126 | gitglossary(7) on "object type": https://git-scm.com/docs/gitglossary#def_object_type |
127 | 127 | """ |
128 | 128 |
|
129 | | -# FIXME: Replace uses with AnyGitObject and Commit_ish, and remove this. |
130 | | -Old_commit_ish=Union["Commit","TagObject","Blob","Tree"] |
131 | | -"""Union of the :class:`~git.objects.base.Object`-based types that represent git object |
132 | | -types. This union is often usable where a commit-ish is expected, but is not actually |
133 | | -limited to types representing commit-ish git objects. |
134 | | -
|
135 | | -See gitglossary(7) on: |
136 | | -
|
137 | | -* "commit-ish": https://git-scm.com/docs/gitglossary#def_commit-ish |
138 | | -* "object type": https://git-scm.com/docs/gitglossary#def_object_type |
139 | | -
|
140 | | -:note: |
141 | | - This union comprises **more** classes than those whose instances really represent |
142 | | - commit-ish git objects: |
143 | | -
|
144 | | - * A :class:`~git.objects.commit.Commit` is of course always commit-ish, and a |
145 | | - :class:`~git.objects.tag.TagObject` is commit-ish if, when peeled (recursively |
146 | | - followed), a :class:`~git.objects.commit.Commit` is obtained. |
147 | | - * However, :class:`~git.objects.blob.Blob` and :class:`~git.objects.tree.Tree` are |
148 | | - also included, and they represent git objects that are never really commit-ish. |
149 | | -
|
150 | | - This is an inversion of the situation with :class:`Tree_ish`, which is narrower than |
151 | | - all tree-ish objects. It is done for practical reasons including backward |
152 | | - compatibility. |
153 | | -""" |
154 | 129 |
|
155 | 130 | # FIXME: After replacing the one use with GitObjectTypeString, define Lit_commit_ish |
156 | 131 | # somehow (it is a breaking change to remove it entirely). Maybe deprecate it. |
|