Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ EOF

When writing documentation (README, CHANGES, docs/), follow these rules for code blocks:

**One command per code block.** This makes commands individually copyable.
**One command per code block.** This makes commands individually copyable. For sequential commands, either use separate code blocks or chain them with `&&` or `;` and `\` continuations (keeping it one logical command).

**Put explanations outside the code block**, not as comments inside.

Expand Down Expand Up @@ -432,6 +432,42 @@ $ uv run pytest
$ uv run pytest --cov
```

### Shell Command Formatting

These rules apply to shell commands in documentation (README, CHANGES, docs/), **not** to Python doctests.

**Use `console` language tag with `$ ` prefix.** This distinguishes interactive commands from scripts and enables prompt-aware copy in many terminals.

Good:

```console
$ uv run pytest
```

Bad:

```bash
uv run pytest
```

**Split long commands with `\` for readability.** Each flag or flag+value pair gets its own continuation line, indented. Positional parameters go on the final line.

Good:

```console
$ pipx install \
--suffix=@next \
--pip-args '\--pre' \
--force \
'libvcs'
```

Bad:

```console
$ pipx install --suffix=@next --pip-args '\--pre' --force 'libvcs'
```

## Debugging Tips

When stuck in debugging loops:
Expand Down
11 changes: 7 additions & 4 deletions CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -393,14 +393,17 @@ _Maintenance only, no bug fixes, or new features_

via ruff v0.3.4, all automated lint fixes, including unsafe and previews were applied:

```sh
ruff check --select ALL . --fix --unsafe-fixes --preview --show-fixes; ruff format .
```console
$ ruff check --select ALL . \
--fix --unsafe-fixes \
--preview --show-fixes; \
ruff format .
```

Branches were treated with:

```sh
git rebase \
```console
$ git rebase \
--strategy-option=theirs \
--exec 'poetry run ruff check --select ALL . --fix --unsafe-fixes --preview --show-fixes; poetry run ruff format .; git add src tests; git commit --amend --no-edit' \
origin/master
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,20 @@ It powers [vcspull](https://github.com/vcs-python/vcspull) and simplifies VCS in

## Installation

```bash
pip install libvcs
```console
$ pip install libvcs
```

With [uv](https://docs.astral.sh/uv/):

```bash
uv add libvcs
```console
$ uv add libvcs
```

Try it interactively:

```bash
uvx --with libvcs ipython
```console
$ uvx --with libvcs ipython
```

Tip: libvcs is pre-1.0. Pin a version range in projects to avoid surprises:
Expand Down
Loading