morrySnow commented on code in PR #1953:
URL: https://github.com/apache/doris-website/pull/1953#discussion_r1944487830


##########
docs/sql-manual/sql-statements/table-and-view/data-and-status-management/CLEAN-TRASH.md:
##########
@@ -26,29 +25,30 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-
 ## Description
 
-This statement is used to clean up garbage data in the backend
+This statement is used to clear garbage data in backend.
 
-grammar:
+## Syntax
 
 ```sql
 ADMIN CLEAN TRASH [ON ("BackendHost1:BackendHeartBeatPort1", 
"BackendHost2:BackendHeartBeatPort2", ...)];
 ```
 
-illustrate:
-
-1. Use BackendHost:BackendHeartBeatPort to indicate the backend that needs to 
be cleaned up, and clean up all backends without adding the on limit.
-
-## Example
+## Parameters
 
-1. Clean up the junk data of all be nodes.
+| Parameter  | Description |
+| ----- | ---- |
+| ON    | Specify the backend to be cleaned up. If you do not add ON, all 
backend is cleared by default. |
 
-        ADMIN CLEAN TRASH;
+## Examples
 
-2. Clean up the junk data of '192.168.0.1:9050' and '192.168.0.2:9050'.

Review Comment:
   缺少权限章节



##########
docs/sql-manual/sql-statements/table-and-view/data-and-status-management/CLEAN-TRASH.md:
##########
@@ -26,29 +25,30 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-
 ## Description
 
-This statement is used to clean up garbage data in the backend
+This statement is used to clear garbage data in backend.
 
-grammar:
+## Syntax
 
 ```sql
 ADMIN CLEAN TRASH [ON ("BackendHost1:BackendHeartBeatPort1", 
"BackendHost2:BackendHeartBeatPort2", ...)];

Review Comment:
   1. 参数需要尖括号包裹
   2. 重复的可选参数格式应为 `[, ...]`
   3. 参数应为小写,单词间下划线分隔
   ```suggestion
   ADMIN CLEAN TRASH [ON ("<be_host>:<be_heartbeat_port>" [, ...])];
   ```



##########
docs/sql-manual/sql-statements/table-and-view/data-and-status-management/CLEAN-TRASH.md:
##########
@@ -26,29 +25,30 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-
 ## Description
 
-This statement is used to clean up garbage data in the backend
+This statement is used to clear garbage data in backend.
 
-grammar:
+## Syntax
 
 ```sql
 ADMIN CLEAN TRASH [ON ("BackendHost1:BackendHeartBeatPort1", 
"BackendHost2:BackendHeartBeatPort2", ...)];
 ```
 
-illustrate:
-
-1. Use BackendHost:BackendHeartBeatPort to indicate the backend that needs to 
be cleaned up, and clean up all backends without adding the on limit.
-
-## Example
+## Parameters
 
-1. Clean up the junk data of all be nodes.
+| Parameter  | Description |
+| ----- | ---- |
+| ON    | Specify the backend to be cleaned up. If you do not add ON, all 
backend is cleared by default. |

Review Comment:
   1. 语句参数的格式不是表格。
   2. 应区分必选参数(Required Parameters)和可选参数章节(Optional Parameters)
   ```suggestion
   ** 1. [ON ("<be_host>:<be_heartbeat_port>" [, ...])] **
   > 这里写参数描述
   ```



##########
docs/sql-manual/sql-statements/table-and-view/data-and-status-management/SHOW-TRASH.md:
##########


Review Comment:
   和 clean trash 类似的问题



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org

Reply via email to