Skip to content

Commit bb362b8

Browse files
docs: Synchronize with hz (#797)
Co-authored-by: kinggo <[email protected]>
1 parent 766b673 commit bb362b8

File tree

8 files changed

+8
-28
lines changed

8 files changed

+8
-28
lines changed

content/en/docs/hertz/tutorials/toolkit/annotation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ referenced [supported-tags](https://www.cloudwego.io/docs/hertz/tutorials/basic-
4949

5050
### hz client
5151

52-
In addition to the annotations provided by [hz](#hz), two additional annotations have been added for client scenarios.
52+
In addition to the annotations provided by [hz](#hz), one additional annotation has been added for client scenarios.
5353

5454
| _Client annotation_ | |
5555
|---------------------|-------------------------------------------|

content/en/docs/hertz/tutorials/toolkit/command.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -451,8 +451,6 @@ OPTIONS:
451451
--snake_tag Use snake_case style naming for tags. (Only works for 'form', 'query', 'json') (default: false)
452452
--rm_tag value [ --rm_tag value ] Remove the specified tag
453453
--exclude_file value, -E value [ --exclude_file value, -E value ] Specify the files that do not need to be updated.
454-
--customize_layout value Specify the path for layout template.
455-
--customize_layout_data_path value Specify the path for layout template render data.
456454
--customize_package value Specify the path for package template.
457455
--protoc-plugins value [ --protoc-plugins value ] Specify plugins for the protoc. ({plugin_name}:{options}:{out_dir})
458456
--thrift-plugins value [ --thrift-plugins value ] Specify plugins for the thriftgo. ({plugin_name}:{options})
@@ -531,14 +529,6 @@ OPTIONS:
531529

532530
<!---->
533531

534-
- customize_layout: Customize the project layout template, please refer to [hz custom template use](https://www.cloudwego.io/docs/hertz/tutorials/toolkit/more-feature/template/)
535-
536-
<!---->
537-
538-
- customize_layout_data_path value: Custom project layout template rendering parameters, please refer to [hz custom template use](https://www.cloudwego.io/docs/hertz/tutorials/toolkit/more-feature/template/)
539-
540-
<!---->
541-
542532
- customize_package: Customized project package related templates can mainly be customized for handler templates. Please refer to [hz custom template use](https://www.cloudwego.io/docs/hertz/tutorials/toolkit/more-feature/template/)
543533

544534
<!---->

content/en/docs/hertz/tutorials/toolkit/layout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ The structure of the code generated by hz is similar. Below, we will use the thr
3737
├── router.go // user defined routing methods other than IDL
3838
└── router_gen.go // the route registration code generated by hz, for calling user-defined routes and routes generated by hz
3939
├── .hz // create code flags for hz without modification
40-
├── build.sh // program compilation script cannot be run under Windows, you can directly use the go build command to compile the program
40+
├── build.sh // program compilation script, default not generated under Windows, you can directly use the go build command to compile the program
4141
├── script
42-
│ └── bootstrap.sh // program running script, cannot run under Windows, can directly run main.go
42+
│ └── bootstrap.sh // program running script, default not generated under Windows, you can directly run main.go
4343
└── .gitignore
4444
```
4545

content/en/docs/hertz/tutorials/toolkit/more-feature/client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This example is based on thrift, and protoc is similar to it.
2626

2727
>The definition and semantics of the IDL are exactly the same as the current definition, so it is basically possible to generate client code without modifying the original IDL.
2828
29-
>But for the client scenario, two annotations have been added,
29+
>But for the client scenario, one annotation has been added,
3030
>api.base_domain: specifies the default request domain to access.
3131
3232
```thrift

content/zh/docs/hertz/tutorials/toolkit/annotation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Field 注解 tag
4848

4949
### hz client
5050

51-
[hz](#hz) 提供的注解外,为针对 client 的场景,额外增加了两种注解
51+
[hz](#hz) 提供的注解外,为针对 client 的场景,额外增加了一种注解
5252

5353
| _Client 注解_ | |
5454
|-----------------|------------------|

content/zh/docs/hertz/tutorials/toolkit/command.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -451,8 +451,6 @@ OPTIONS:
451451
--snake_tag Use snake_case style naming for tags. (Only works for 'form', 'query', 'json') (default: false)
452452
--rm_tag value [ --rm_tag value ] Remove the specified tag
453453
--exclude_file value, -E value [ --exclude_file value, -E value ] Specify the files that do not need to be updated.
454-
--customize_layout value Specify the path for layout template.
455-
--customize_layout_data_path value Specify the path for layout template render data.
456454
--customize_package value Specify the path for package template.
457455
--protoc-plugins value [ --protoc-plugins value ] Specify plugins for the protoc. ({plugin_name}:{options}:{out_dir})
458456
--thrift-plugins value [ --thrift-plugins value ] Specify plugins for the thriftgo. ({plugin_name}:{options})
@@ -531,14 +529,6 @@ OPTIONS:
531529

532530
<!---->
533531

534-
- customize_layout: 自定义项目 layout 模板,具体详见:[自定义模板使用](https://www.cloudwego.io/zh/docs/hertz/tutorials/toolkit/more-feature/template/)
535-
536-
<!---->
537-
538-
- customize_layout_data_path value: 自定义项目 layout 模板渲染参数,具体详见:[自定义模板使用](https://www.cloudwego.io/zh/docs/hertz/tutorials/toolkit/more-feature/template/)
539-
540-
<!---->
541-
542532
- customize_package: 自定义项目 package 相关模板,主要可针对 handler 模板进行定制化,具体详见:[自定义模板使用](https://www.cloudwego.io/zh/docs/hertz/tutorials/toolkit/more-feature/template/)
543533

544534
<!---->

content/zh/docs/hertz/tutorials/toolkit/layout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ hz 生成的代码结构都类似,下面以 [hz 使用 (thrift)](/zh/docs/hert
3737
├── router.go // 用户自定义除 idl 外的路由方法
3838
├── router_gen.go // hz 生成的路由注册代码,用于调用用户自定义的路由以及 hz 生成的路由
3939
├── .hz // hz 创建代码标志,无需改动
40-
├── build.sh // 程序编译脚本,Windows 下不能运行,可直接使用 go build 命令编译程序
40+
├── build.sh // 程序编译脚本,Windows 下默认不生成,可直接使用 go build 命令编译程序
4141
├── script
42-
│ └── bootstrap.sh // 程序运行脚本,Windows 下不能运行,可直接运行 main.go
42+
│ └── bootstrap.sh // 程序运行脚本,Windows 下默认不生成,可直接运行 main.go
4343
└── .gitignore
4444
```
4545

content/zh/docs/hertz/tutorials/toolkit/more-feature/client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ hz client 生成的代码结构可以参考 [hz client](/zh/docs/hertz/tutorials
2626

2727
>IDL 的定义和语义与目前的定义完全相同,所以基本不用修改原先的 IDL 即可生成 client 代码。
2828
29-
>但是为针对 client 的场景,增加了两种注解
29+
>但是为针对 client 的场景,增加了一种注解
3030
>api.base_domain:指定默认访问的请求 domain。
3131
3232
```thrift

0 commit comments

Comments
 (0)