Skip to content

Commit 996da51

Browse files
committed
docs(utils): Note the APIs are internal
1 parent fcfaf3e commit 996da51

File tree

4 files changed

+28
-2
lines changed

4 files changed

+28
-2
lines changed

libvcs/utils/dataclasses.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
""":mod:`dataclasses` utilities.
2+
3+
Note
4+
----
5+
This is an internal API not covered by versioning policy.
6+
"""
17
import dataclasses
28
from operator import attrgetter
39

libvcs/utils/query_list.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
"""Utilities for filtering or searching :class:`list` of objects / list data.
2+
3+
Note
4+
----
5+
This is an internal API not covered by versioning policy.
6+
"""
17
import re
28
import traceback
39
from typing import Any, Callable, Optional, Protocol, Sequence, TypeVar, Union

libvcs/utils/run.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
"""Utility functions for libvcs."""
1+
"""Misc. legacy helpers :mod:`subprocess` and finding VCS binaries.
2+
3+
:class:`libvcs.utils.run.run` will be deprecated by :mod:`libvcs.utils.subprocess`.
4+
5+
Note
6+
----
7+
This is an internal API not covered by versioning policy.
8+
"""
29
import datetime
310
import errno
411
import logging

libvcs/utils/subprocess.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
1-
"""Invokable subprocess wrapper.
1+
"""Invokable :mod:`subprocess` wrapper.
22
33
Defer running a subprocess, such as by handing to an executor.
44
5+
Note
6+
----
7+
This is an internal API not covered by versioning policy.
8+
9+
Examples
10+
--------
11+
512
- :class:`~SubprocessCommand`: Wraps :class:`subprocess.Popen` and
613
:func:`subprocess.run` in a :func:`~dataclasses.dataclass`.
714

0 commit comments

Comments
 (0)