Skip to content

Commit 7c2dd7c

Browse files
committed
docs(types): Document libvcs.types
1 parent d84dcba commit 7c2dd7c

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

libvcs/types.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1+
"""Internal :term:`type annotations <annotation>`
2+
3+
Notes
4+
-----
5+
6+
:class:`StrPath` and :class:`StrOrBytesPath` is based on `typeshed's`_.
7+
8+
.. _typeshed's: https://github.com/python/typeshed/blob/5df8de7/stdlib/_typeshed/__init__.pyi#L115-L118
9+
""" # NOQA E501
110
from os import PathLike
211
from typing import TypeAlias, Union
312

4-
# via github.com/python/typeshed/blob/5df8de7/stdlib/_typeshed/__init__.pyi#L115-L118
5-
6-
#: :class:`os.PathLike` or :func:`str`
713
StrPath: TypeAlias = Union[str, PathLike[str]] # stable
8-
#: :class:`os.PathLike`, :func:`str` or :term:`bytes-like object`
14+
""":class:`os.PathLike` or :class:`str`"""
15+
916
StrOrBytesPath: TypeAlias = Union[str, bytes, PathLike[str], PathLike[bytes]] # stable
17+
""":class:`os.PathLike`, :class:`str` or :term:`bytes-like object`"""

0 commit comments

Comments
 (0)