Skip to content

Commit 6ed24ef

Browse files
committed
docs(internals): Add async_run and async_subprocess docs
why: Document internal async APIs alongside sync equivalents what: - Create async_run.md with automodule reference - Create async_subprocess.md with automodule reference - Update internals/index.md toctree
1 parent a2f6281 commit 6ed24ef

3 files changed

Lines changed: 18 additions & 0 deletions

File tree

docs/internals/async_run.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# async_run - `libvcs._internal.async_run`
2+
3+
Async equivalent of {mod}`libvcs._internal.run`.
4+
5+
```{eval-rst}
6+
.. automodule:: libvcs._internal.async_run
7+
:members:
8+
```

docs/internals/async_subprocess.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# AsyncSubprocessCommand - `libvcs._internal.async_subprocess`
2+
3+
Async equivalent of {mod}`libvcs._internal.subprocess`.
4+
5+
```{eval-rst}
6+
.. automodule:: libvcs._internal.async_subprocess
7+
:members:
8+
```

docs/internals/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ types
1414
dataclasses
1515
query_list
1616
run
17+
async_run
1718
subprocess
19+
async_subprocess
1820
shortcuts
1921
```

0 commit comments

Comments
 (0)