Skip to content

Commit 1450748

Browse files
committed
docs(cmd,sync): Add async variant references
why: Document the new async command and sync classes. what: - Add AsyncGit, AsyncHg, AsyncSvn to cmd/index.md - Add AsyncGitSync, AsyncHgSync, AsyncSvnSync to sync/index.md
1 parent 5a353f6 commit 1450748

2 files changed

Lines changed: 20 additions & 0 deletions

File tree

docs/cmd/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,16 @@ The `libvcs.cmd` module provides Python wrappers for VCS command-line tools:
2121
- {mod}`libvcs.cmd.hg` - Mercurial commands
2222
- {mod}`libvcs.cmd.svn` - Subversion commands
2323

24+
### Async Variants
25+
26+
Async equivalents are available in `libvcs.cmd._async`:
27+
28+
- {class}`~libvcs.cmd._async.git.AsyncGit` - Async git commands
29+
- {class}`~libvcs.cmd._async.hg.AsyncHg` - Async mercurial commands
30+
- {class}`~libvcs.cmd._async.svn.AsyncSvn` - Async subversion commands
31+
32+
See {doc}`/topics/asyncio` for usage patterns.
33+
2434
### When to use `cmd` vs `sync`
2535

2636
| Module | Use Case |

docs/sync/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,16 @@ versions.
1414

1515
:::
1616

17+
## Async Variants
18+
19+
Async equivalents are available in `libvcs.sync._async`:
20+
21+
- {class}`~libvcs.sync._async.git.AsyncGitSync` - Async git repository management
22+
- {class}`~libvcs.sync._async.hg.AsyncHgSync` - Async mercurial repository management
23+
- {class}`~libvcs.sync._async.svn.AsyncSvnSync` - Async subversion repository management
24+
25+
See {doc}`/topics/asyncio` for usage patterns.
26+
1727
```{toctree}
1828
:caption: API
1929

0 commit comments

Comments
 (0)