From 488b0a57197b59302b313f28d26e16cc0b784a10 Mon Sep 17 00:00:00 2001
From: Frost Ming <me@frostming.com>
Date: Wed, 10 Jan 2024 09:24:01 +0800
Subject: [PATCH] doc: about environment substitution

Signed-off-by: Frost Ming <me@frostming.com>
---
 docs/docs/usage/scripts.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/docs/docs/usage/scripts.md b/docs/docs/usage/scripts.md
index b99efc4171..2e0374cd5e 100644
--- a/docs/docs/usage/scripts.md
+++ b/docs/docs/usage/scripts.md
@@ -133,6 +133,11 @@ start.env = {FOO = "bar", FLASK_ENV = "development"}
 
 Note how we use [TOML's syntax](https://github.com/toml-lang/toml) to define a composite dictionary.
 
+!!! note "About environment variable substitution"
+    Variables in script specifications can be substituted in all script types. In `cmd` scripts, only `${VAR}`
+    syntax is supported on all platforms, however in `shell` scripts, the syntax is platform-dependent. For example,
+    Windows cmd uses `%VAR%` while bash uses `$VAR`.
+
 !!! note
     Environment variables specified on a composite task level will override those defined by called tasks.