From 77452d3292af4ab2f0043b9d814d038a448d7f6b Mon Sep 17 00:00:00 2001
From: defnngj <defnngj@gmail.com>
Date: Sat, 28 Dec 2024 10:48:49 +0800
Subject: [PATCH] :pencil: update `env` doc

---
 docs/vpdocs/getting-started/data_driver.md | 43 ++++++++++++++++------
 docs/vpdocs/platform/platform.md           |  2 +-
 2 files changed, 33 insertions(+), 12 deletions(-)

diff --git a/docs/vpdocs/getting-started/data_driver.md b/docs/vpdocs/getting-started/data_driver.md
index 74a6c604..8316379f 100644
--- a/docs/vpdocs/getting-started/data_driver.md
+++ b/docs/vpdocs/getting-started/data_driver.md
@@ -332,9 +332,9 @@ mypro/
 .
 └── test_data
     ├── develop
-    │   └── test_data.json
+    │   └── test_data.json
     ├── product
-    │   └── test_data.json
+    │   └── test_data.json
     └── test
         └── test_data.json
 ```
@@ -344,11 +344,11 @@ mypro/
 ```shell
 .
 ├── develop
-│   └── test_data
-│       └── test_data.json
+│   └── test_data
+│       └── test_data.json
 ├── product
-│   └── test_data
-│       └── test_data.json
+│       └── test_data
+│         └── test_data.json
 └── test
     └── test_data
         └── test_data.json
@@ -359,7 +359,6 @@ mypro/
 ```python
 import seldom
 from seldom import file_data
-from seldom import Seldom
 
 
 class MyTest(seldom.TestCase):
@@ -378,16 +377,38 @@ class MyTest(seldom.TestCase):
 
 
 if __name__ == '__main__':
-    Seldom.env = "product"  # test/develop/product 设置当前环境
-    seldom.main(debug=True)
+    # test/develop/product 设置当前环境
+    seldom.main(debug=True, env="product")
 ```
 
-`Seldom.env` 默认为`None`，当设置了环境，`@file_data()` 会带上环境的目录名，例如:
+`env` 默认为`None`，当设置了`环境变量`，`@file_data()`会带上`环境变量`的目录名，例如:
 
 * `test_data.json` 查找的文件为 `product/test_data.json`
 * `test_data/test_data.json` 查找的文件为 `product/test_data/test_data.json`
 
-> `Seldom.env` 可以随意命名，但最好遵循一定的规范:`test/develop/product`。你还可以利用`Seldom.env`变量本地创建更多的配置。
+> * `env` 可以随意命名，但最好遵循一定的规范，例如`test/develop/product`用于区分不同的环境。
+> * 我们还可以利用`env`环境变量实现更多的配置，下面的示例。
+
+```python
+import seldom
+from seldom import Seldom
+
+
+class MyTest(seldom.TestCase):
+
+    def test_env(self):
+        if Seldom.env == "product":
+            username = "admin"
+        elif Seldom.env == "develop":
+            username = "guest"
+        else:
+            username = "tom"
+        ...
+
+
+if __name__ == '__main__':
+    seldom.main(debug=True, env="product")
+```
 
 ### @api_data()方法
 
diff --git a/docs/vpdocs/platform/platform.md b/docs/vpdocs/platform/platform.md
index 0b1b337d..9010a1da 100644
--- a/docs/vpdocs/platform/platform.md
+++ b/docs/vpdocs/platform/platform.md
@@ -163,7 +163,7 @@ if __name__ == '__main__':
 * `TestMainExtend(path="./test_dir")` : 其中`path`指定从哪个目录查找用例集合。
 * `run_cases(cases)`: 运行用例。
 
-### 接入平台比读
+### 接入平台必读
 
 如果你只是使用seldom框架编写用例，那么代码只要框架能运行即可，如果要接入seldom-platform平台，那么需要注意一下几点。