Skip to content

Commit dfa3748

Browse files
committed
chore(env/lint): some bolding in environment + correction to the lintquarto commands in linting
1 parent 7097066 commit dfa3748

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

pages/setup/environment.qmd

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,9 +161,9 @@ In R, managing your project environment typically requires multiple, specialised
161161

162162
:::: {.python-content}
163163

164-
This book and its examples use `conda`/`mamba`, as they are established tools for package management that can also install specific versions of Python, enabling you to easily switch between versions for different projects.
164+
This book and its examples use `conda`/`mamba`, as they are **established** tools for package management that can also install **specific versions of Python**, enabling you to easily switch between versions for different projects.
165165

166-
You can choose between them - `mamba` is just a drop-in replacement for `conda` that is faster and has clearer error messages.
166+
You can choose between them - **`mamba` is just a drop-in replacement for `conda`** that is faster and has clearer error messages.
167167

168168
### Install `conda`/`mamba`
169169

@@ -193,7 +193,6 @@ dependencies:
193193
::: {.callout-note}
194194

195195
## Conda channels
196-
`For example:
197196

198197
**Channels** are locations where conda stores and retrieves packages. You can choose which channel to use, and can a select a few with an order of priority.
199198

pages/style_docs/linting.qmd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -320,18 +320,18 @@ pip install lintquarto
320320
To run it, follow this format:
321321

322322
```{.bash}
323-
lintquarto [linter] [files or folders] [-k | --keep-temp]
323+
lintquarto -l LINTER [LINTER ...] -p PATH [PATH ...] [-e EXCLUDE [EXCLUDE ...]] [-k]
324324
```
325325

326-
* **[linter]** - Choose one of the supported linters: `pylint`, `flake8`, `pyflakes`, `ruff`, `pylama`, `vulture`, `radon`, `pycodestyle`, `mypy`, `pyright`, `pyrefly`, or `pytype`
327-
328-
* **[files or folders]** - One or more `.qmd` files or directories to lint.
326+
* **-l --linters** LINTER [LINTER ...] - Linters to run. Valid options: `pylint`, `flake8`, `pyflakes`, `ruff`, `vulture`, `radon`, `pycodestyle`, `mypy`, `pyright`, `pyrefly`, or `pytype`.
327+
* **-p --paths** PATH [PATH ...]- Quarto files and/or directories to lint.
328+
* **-e --exclude** EXCLUDE [EXCLUDE ...] - Files and/or directories to exclude from linting.
329329
* **-k, --keep-temp** - Keep the temporary `.py` files created during linting (for debugging).
330330

331-
So, for example, to run `pylint`:
331+
So, for example, to run `pylint` in the current directory (and sub-directories):
332332

333333
```{.bash}
334-
lintquarto pylint file.qmd
334+
lintquarto -l pylint -p .
335335
```
336336
:::
337337

0 commit comments

Comments
 (0)