From 8912e567d08ba17184fd728040c733d9639e8790 Mon Sep 17 00:00:00 2001 From: yougotwill Date: Wed, 5 Feb 2025 17:18:24 +1100 Subject: [PATCH] fix: use correct warning alert syntax --- CONTRIBUTING.md | 3 ++- tools/README.md | 5 ++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd5553e4e..ef5b42a84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,7 +35,8 @@ If you use other python versions you might have or need a python version manager - [asdf](https://asdf-vm.com/) - you can run `asdf install` in the project directory and it will use the python version specified in `.tool-versions`. --> ⚠️ **Warning:** [setuptools](https://pypi.org/project/setuptools/) was removed in Python 3.12, so you'll need to install it manually. +> [!WARNING] +> The package [setuptools](https://pypi.org/project/setuptools/) was removed in Python 3.12, so you'll need to install it manually. ```shell pip install setuptools diff --git a/tools/README.md b/tools/README.md index 28715d43d..99f63af87 100644 --- a/tools/README.md +++ b/tools/README.md @@ -45,9 +45,8 @@ The script can automatically open the files in VSCode by passing the `--open` fl python3 ./tools/findString.py --open ``` -**Warning:** The --open flag will open only the first result for the token in VSCode. If you wish to open more files, -you can pass the `--limit` flag with the maximum number of files you wish to open. You can also pass the `--limit 0` -flag to open all files containing the token. +> [!WARNING] +> The --open flag will open only the first result for the token in VSCode. If you wish to open more files, you can pass the `--limit` flag with the maximum number of files you wish to open. You can also pass the `--limit 0` flag to open all files containing the token. ```bash python3 ./tools/findString.py --open --limit 5