@@ -225,10 +225,10 @@ def _get_ref_info_helper(
225
225
) -> Union [Tuple [str , None ], Tuple [None , str ]]:
226
226
"""
227
227
:return:
228
- (str(sha), str(target_ref_path)) if available, the sha the file at rela_path
229
- points to, or ``None``.
228
+ *(str(sha), str(target_ref_path))*, where:
230
229
231
- target_ref_path is the reference we point to, or ``None``.
230
+ * *sha* is of the file at rela_path points to if available, or ``None``.
231
+ * *target_ref_path* is the reference we point to, or ``None``.
232
232
"""
233
233
if ref_path :
234
234
cls ._check_ref_name_valid (ref_path )
@@ -270,10 +270,11 @@ def _get_ref_info_helper(
270
270
@classmethod
271
271
def _get_ref_info (cls , repo : "Repo" , ref_path : Union [PathLike , None ]) -> Union [Tuple [str , None ], Tuple [None , str ]]:
272
272
"""
273
- :return: (str(sha), str(target_ref_path)) if available, the sha the file at
274
- rela_path points to, or None.
273
+ :return:
274
+ *(str(sha), str(target_ref_path))*, where:
275
275
276
- target_ref_path is the reference we point to, or ``None``.
276
+ * *sha* is of the file at rela_path points to if available, or ``None``.
277
+ * *target_ref_path* is the reference we point to, or ``None``.
277
278
"""
278
279
return cls ._get_ref_info_helper (repo , ref_path )
279
280
@@ -290,9 +291,9 @@ def _get_object(self) -> Commit_ish:
290
291
def _get_commit (self ) -> "Commit" :
291
292
"""
292
293
:return:
293
- Commit object we point to. This works for detached and non-detached
294
- :class:`SymbolicReference` instances. The symbolic reference will be
295
- dereferenced recursively.
294
+ :class:`~git.objects.commit. Commit` object we point to. This works for
295
+ detached and non-detached :class:`SymbolicReference` instances. The symbolic
296
+ reference will be dereferenced recursively.
296
297
"""
297
298
obj = self ._get_object ()
298
299
if obj .type == "tag" :
0 commit comments