Skip to content

Commit 3d11b56

Browse files
committed
chore: format all documents
Signed-off-by: peefy <xpf6677@163.com>
1 parent e0551a2 commit 3d11b56

File tree

23 files changed

+210
-206
lines changed

23 files changed

+210
-206
lines changed

blog/2024-02-22-newsletter/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ KCL has released preview version 0.8.0, mainly including the following updates:
6060

6161
In addition to using Python for KCL plugin functions, it now supports using Go to write plugin functions for KCL, which is very simple to use.
6262

63-
+ Define a plugin (using a hello plugin containing the add function as an example)
63+
- Define a plugin (using a hello plugin containing the add function as an example)
6464

6565
```go
6666
package hello_plugin
@@ -84,7 +84,7 @@ func init() {
8484
}
8585
```
8686

87-
+ Use the plugin
87+
- Use the plugin
8888

8989
```go
9090
package main

docs/reference/model/file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Return a list containing all file names that match `pattern`.
2222

2323
`modpath() -> str`
2424

25-
Return the root path of the current KCL module (kcl.mod file path or single *.k file path).
25+
Return the root path of the current KCL module (kcl.mod file path or single \*.k file path).
2626

2727
## workdir
2828

docs/reference/xlang-api/go-api.md

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -93,50 +93,50 @@ x1 = Person {
9393
## Index
9494

9595
- [Go API](#go-api)
96-
- [Index](#index)
97-
- [Constants](#constants)
98-
- [func FormatCode](#func-formatcode)
99-
- [func FormatPath](#func-formatpath)
100-
- [func GetSchemaTypeMapping](#func-getschematypemapping)
101-
- [func InitKclvmPath](#func-initkclvmpath)
102-
- [func InitKclvmRuntime](#func-initkclvmruntime)
103-
- [func LintPath](#func-lintpath)
104-
- [func ListDepFiles](#func-listdepfiles)
105-
- [func ListDownStreamFiles](#func-listdownstreamfiles)
106-
- [func ListUpStreamFiles](#func-listupstreamfiles)
107-
- [func OverrideFile](#func-overridefile)
108-
- [func Validate](#func-validate)
109-
- [func ValidateCode](#func-validatecode)
110-
- [type KCLResult](#type-kclresult)
111-
- [type KCLResultList](#type-kclresultlist)
112-
- [func MustRun](#func-mustrun)
113-
- [func Run](#func-run)
114-
- [func RunFiles](#func-runfiles)
115-
- [type KclType](#type-kcltype)
116-
- [func GetSchemaType](#func-getschematype)
117-
- [type ListDepFilesOption](#type-listdepfilesoption)
118-
- [type ListDepsOptions](#type-listdepsoptions)
119-
- [type Option](#type-option)
120-
- [func WithCode](#func-withcode)
121-
- [func WithDisableNone](#func-withdisablenone)
122-
- [func WithExternalPkgs](#func-withexternalpkgs)
123-
- [func WithFullTypePath](#func-withfulltypepath)
124-
- [func WithIncludeSchemaTypePath](#func-withincludeschematypepath)
125-
- [func WithKFilenames](#func-withkfilenames)
126-
- [func WithLogger](#func-withlogger)
127-
- [func WithOptions](#func-withoptions)
128-
- [func WithOverrides](#func-withoverrides)
129-
- [func WithPrintOverridesAST](#func-withprintoverridesast)
130-
- [func WithSelectors](#func-withselectors)
131-
- [func WithSettings](#func-withsettings)
132-
- [func WithShowHidden](#func-withshowhidden)
133-
- [func WithSortKeys](#func-withsortkeys)
134-
- [func WithWorkDir](#func-withworkdir)
135-
- [type TestCaseInfo](#type-testcaseinfo)
136-
- [type TestOptions](#type-testoptions)
137-
- [type TestResult](#type-testresult)
138-
- [func Test](#func-test)
139-
- [type ValidateOptions](#type-validateoptions)
96+
- [Index](#index)
97+
- [Constants](#constants)
98+
- [func FormatCode](#func-formatcode)
99+
- [func FormatPath](#func-formatpath)
100+
- [func GetSchemaTypeMapping](#func-getschematypemapping)
101+
- [func InitKclvmPath](#func-initkclvmpath)
102+
- [func InitKclvmRuntime](#func-initkclvmruntime)
103+
- [func LintPath](#func-lintpath)
104+
- [func ListDepFiles](#func-listdepfiles)
105+
- [func ListDownStreamFiles](#func-listdownstreamfiles)
106+
- [func ListUpStreamFiles](#func-listupstreamfiles)
107+
- [func OverrideFile](#func-overridefile)
108+
- [func Validate](#func-validate)
109+
- [func ValidateCode](#func-validatecode)
110+
- [type KCLResult](#type-kclresult)
111+
- [type KCLResultList](#type-kclresultlist)
112+
- [func MustRun](#func-mustrun)
113+
- [func Run](#func-run)
114+
- [func RunFiles](#func-runfiles)
115+
- [type KclType](#type-kcltype)
116+
- [func GetSchemaType](#func-getschematype)
117+
- [type ListDepFilesOption](#type-listdepfilesoption)
118+
- [type ListDepsOptions](#type-listdepsoptions)
119+
- [type Option](#type-option)
120+
- [func WithCode](#func-withcode)
121+
- [func WithDisableNone](#func-withdisablenone)
122+
- [func WithExternalPkgs](#func-withexternalpkgs)
123+
- [func WithFullTypePath](#func-withfulltypepath)
124+
- [func WithIncludeSchemaTypePath](#func-withincludeschematypepath)
125+
- [func WithKFilenames](#func-withkfilenames)
126+
- [func WithLogger](#func-withlogger)
127+
- [func WithOptions](#func-withoptions)
128+
- [func WithOverrides](#func-withoverrides)
129+
- [func WithPrintOverridesAST](#func-withprintoverridesast)
130+
- [func WithSelectors](#func-withselectors)
131+
- [func WithSettings](#func-withsettings)
132+
- [func WithShowHidden](#func-withshowhidden)
133+
- [func WithSortKeys](#func-withsortkeys)
134+
- [func WithWorkDir](#func-withworkdir)
135+
- [type TestCaseInfo](#type-testcaseinfo)
136+
- [type TestOptions](#type-testoptions)
137+
- [type TestResult](#type-testresult)
138+
- [func Test](#func-test)
139+
- [type ValidateOptions](#type-validateoptions)
140140

141141
## Constants
142142

docs/reference/xlang-api/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,8 @@ The output is
200200

201201
```json
202202
{
203-
"error": "",
204-
"result": {}
203+
"error": "",
204+
"result": {}
205205
}
206206
```
207207

docs/reference/xlang-api/rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ message ExecProgram_Args {
290290
291291
repeated string k_filename_list = 2;
292292
repeated string k_code_list = 3;
293-
293+
294294
repeated CmdArgSpec args = 4;
295295
repeated CmdOverrideSpec overrides = 5;
296296

docs/user_docs/guides/gitops/2-fluxcd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Apply the `GitRepository` object to the cluster by running the `kubectl apply -f
9797
Check the deployment result by running the `kubectl get deployments` command.
9898

9999
```
100-
kubectl get deployments
100+
kubectl get deployments
101101
```
102102
103103
You can see the result, and the deployment is successful.

docs/user_docs/support/faq-kcl.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2464,6 +2464,7 @@ a: 1
24642464
## 56. How to write a schema where a property can have one or more different schemas of definitions?
24652465
24662466
We can use union types (sum types) in KCL. For example
2467+
24672468
```shell
24682469
schema Config:
24692470
route: EndPoint | Gateway
@@ -2501,7 +2502,7 @@ In KCL, we can use `${..}` for string interpolation. But in some cases, we don't
25012502
```KCL
25022503
worldString = "world"
25032504
s = "Hello ${worldString}"
2504-
raw_s = r"Hello ${worldString}"
2505+
raw_s = r"Hello ${worldString}"
25052506
```
25062507

25072508
The output comes out as:
@@ -2510,3 +2511,4 @@ The output comes out as:
25102511
worldString: world
25112512
s: Hello world
25122513
raw_s: Hello ${worldString}
2514+
```

i18n/zh-CN/docusaurus-plugin-content-blog/2024-02-22-newsletter/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ kcl mod add jsonschema:0.0.4
5959

6060
除了使用 Python 为 KCL 插件函数,现在支持使用 Go 为 KCL 编写插件函数,使用方式非常简单。
6161

62-
+ 定义插件 (以一个包含 add 函数的 hello 插件作为示例)
62+
- 定义插件 (以一个包含 add 函数的 hello 插件作为示例)
6363

6464
```go
6565
package hello_plugin
@@ -83,7 +83,7 @@ func init() {
8383
}
8484
```
8585

86-
+ 使用插件
86+
- 使用插件
8787

8888
```go
8989
package main
@@ -120,7 +120,7 @@ three = hello.add(1,2) # 3
120120
以下排名不分先后
121121

122122
- 感谢 @octonawish-akcodes@d4v1d03
123-
对 KCL FAQ 文档和 KCL IDE 功能的持续贡献 🙌
123+
对 KCL FAQ 文档和 KCL IDE 功能的持续贡献 🙌
124124
- 感谢 @octonawish-akcodes 对 Ansible KCL Module 的贡献
125125
- 感谢 @AkashKumar7902@Vanshikav123 对 KCL 包管理工具功能的贡献 🙌
126126
- 感谢 @StevenLeiZhang 对 KCL 文档和 KCL 插件的贡献

i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/model/file.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ weight: 100
88

99
## read
1010

11-
1211
`read(filepath: string) -> str`
1312

1413
读取文件 `filepath` 中的内容,并返回一个字符串实例。
@@ -23,7 +22,7 @@ weight: 100
2322

2423
`modpath() -> str`
2524

26-
返回当前模块的根路径(kcl.mod 文件路径或单个 *.k 文件路径)。
25+
返回当前模块的根路径(kcl.mod 文件路径或单个 \*.k 文件路径)。
2726

2827
## workdir
2928

i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/xlang-api/go-api.md

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -93,50 +93,50 @@ x1 = Person {
9393
## Index
9494

9595
- [Go API](#go-api)
96-
- [Index](#index)
97-
- [Constants](#constants)
98-
- [func FormatCode](#func-formatcode)
99-
- [func FormatPath](#func-formatpath)
100-
- [func GetSchemaTypeMapping](#func-getschematypemapping)
101-
- [func InitKclvmPath](#func-initkclvmpath)
102-
- [func InitKclvmRuntime](#func-initkclvmruntime)
103-
- [func LintPath](#func-lintpath)
104-
- [func ListDepFiles](#func-listdepfiles)
105-
- [func ListDownStreamFiles](#func-listdownstreamfiles)
106-
- [func ListUpStreamFiles](#func-listupstreamfiles)
107-
- [func OverrideFile](#func-overridefile)
108-
- [func Validate](#func-validate)
109-
- [func ValidateCode](#func-validatecode)
110-
- [type KCLResult](#type-kclresult)
111-
- [type KCLResultList](#type-kclresultlist)
112-
- [func MustRun](#func-mustrun)
113-
- [func Run](#func-run)
114-
- [func RunFiles](#func-runfiles)
115-
- [type KclType](#type-kcltype)
116-
- [func GetSchemaType](#func-getschematype)
117-
- [type ListDepFilesOption](#type-listdepfilesoption)
118-
- [type ListDepsOptions](#type-listdepsoptions)
119-
- [type Option](#type-option)
120-
- [func WithCode](#func-withcode)
121-
- [func WithDisableNone](#func-withdisablenone)
122-
- [func WithExternalPkgs](#func-withexternalpkgs)
123-
- [func WithFullTypePath](#func-withfulltypepath)
124-
- [func WithIncludeSchemaTypePath](#func-withincludeschematypepath)
125-
- [func WithKFilenames](#func-withkfilenames)
126-
- [func WithLogger](#func-withlogger)
127-
- [func WithOptions](#func-withoptions)
128-
- [func WithOverrides](#func-withoverrides)
129-
- [func WithPrintOverridesAST](#func-withprintoverridesast)
130-
- [func WithSelectors](#func-withselectors)
131-
- [func WithSettings](#func-withsettings)
132-
- [func WithShowHidden](#func-withshowhidden)
133-
- [func WithSortKeys](#func-withsortkeys)
134-
- [func WithWorkDir](#func-withworkdir)
135-
- [type TestCaseInfo](#type-testcaseinfo)
136-
- [type TestOptions](#type-testoptions)
137-
- [type TestResult](#type-testresult)
138-
- [func Test](#func-test)
139-
- [type ValidateOptions](#type-validateoptions)
96+
- [Index](#index)
97+
- [Constants](#constants)
98+
- [func FormatCode](#func-formatcode)
99+
- [func FormatPath](#func-formatpath)
100+
- [func GetSchemaTypeMapping](#func-getschematypemapping)
101+
- [func InitKclvmPath](#func-initkclvmpath)
102+
- [func InitKclvmRuntime](#func-initkclvmruntime)
103+
- [func LintPath](#func-lintpath)
104+
- [func ListDepFiles](#func-listdepfiles)
105+
- [func ListDownStreamFiles](#func-listdownstreamfiles)
106+
- [func ListUpStreamFiles](#func-listupstreamfiles)
107+
- [func OverrideFile](#func-overridefile)
108+
- [func Validate](#func-validate)
109+
- [func ValidateCode](#func-validatecode)
110+
- [type KCLResult](#type-kclresult)
111+
- [type KCLResultList](#type-kclresultlist)
112+
- [func MustRun](#func-mustrun)
113+
- [func Run](#func-run)
114+
- [func RunFiles](#func-runfiles)
115+
- [type KclType](#type-kcltype)
116+
- [func GetSchemaType](#func-getschematype)
117+
- [type ListDepFilesOption](#type-listdepfilesoption)
118+
- [type ListDepsOptions](#type-listdepsoptions)
119+
- [type Option](#type-option)
120+
- [func WithCode](#func-withcode)
121+
- [func WithDisableNone](#func-withdisablenone)
122+
- [func WithExternalPkgs](#func-withexternalpkgs)
123+
- [func WithFullTypePath](#func-withfulltypepath)
124+
- [func WithIncludeSchemaTypePath](#func-withincludeschematypepath)
125+
- [func WithKFilenames](#func-withkfilenames)
126+
- [func WithLogger](#func-withlogger)
127+
- [func WithOptions](#func-withoptions)
128+
- [func WithOverrides](#func-withoverrides)
129+
- [func WithPrintOverridesAST](#func-withprintoverridesast)
130+
- [func WithSelectors](#func-withselectors)
131+
- [func WithSettings](#func-withsettings)
132+
- [func WithShowHidden](#func-withshowhidden)
133+
- [func WithSortKeys](#func-withsortkeys)
134+
- [func WithWorkDir](#func-withworkdir)
135+
- [type TestCaseInfo](#type-testcaseinfo)
136+
- [type TestOptions](#type-testoptions)
137+
- [type TestResult](#type-testresult)
138+
- [func Test](#func-test)
139+
- [type ValidateOptions](#type-validateoptions)
140140

141141
## Constants
142142

0 commit comments

Comments
 (0)