Skip to content

Commit e61436a

Browse files
committed
docs(style[shell]): Standardize shell code blocks in docs
why: Improve copy-pastability and readability of shell examples what: - Ensure all shell blocks use console tag with $ prefix - Fix README.md installation examples - Fix CHANGES shell examples
1 parent 1380dfb commit e61436a

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

CHANGES

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -393,14 +393,14 @@ _Maintenance only, no bug fixes, or new features_
393393

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

396-
```sh
397-
ruff check --select ALL . --fix --unsafe-fixes --preview --show-fixes; ruff format .
396+
```console
397+
$ ruff check --select ALL . --fix --unsafe-fixes --preview --show-fixes; ruff format .
398398
```
399399

400400
Branches were treated with:
401401

402-
```sh
403-
git rebase \
402+
```console
403+
$ git rebase \
404404
--strategy-option=theirs \
405405
--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' \
406406
origin/master

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,20 @@ It powers [vcspull](https://github.com/vcs-python/vcspull) and simplifies VCS in
2626

2727
## Installation
2828

29-
```bash
30-
pip install libvcs
29+
```console
30+
$ pip install libvcs
3131
```
3232

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

35-
```bash
36-
uv add libvcs
35+
```console
36+
$ uv add libvcs
3737
```
3838

3939
Try it interactively:
4040

41-
```bash
42-
uvx --with libvcs ipython
41+
```console
42+
$ uvx --with libvcs ipython
4343
```
4444

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

0 commit comments

Comments
 (0)