@@ -78,8 +78,8 @@ func (d DocDefinitions) RenderMarkdown(t *testing.T, repositoryPath string) []by
7878
7979 els += 1
8080
81- write (t , out , "### %s\n \n " , el .Path )
82- write (t , out , "Type: `%s` <sup>[\\ [ref\\ ]](%s/%s#L%d)</sup>\n \n " , el .Type , repositoryPath , el .File , el .Line )
81+ writef (t , out , "### %s\n \n " , el .Path )
82+ writef (t , out , "Type: `%s` <sup>[\\ [ref\\ ]](%s/%s#L%d)</sup>\n \n " , el .Type , repositoryPath , el .File , el .Line )
8383
8484 if grade := el .Grade ; grade != nil {
8585 switch grade .Grade {
@@ -88,44 +88,44 @@ func (d DocDefinitions) RenderMarkdown(t *testing.T, repositoryPath string) []by
8888 write (t , out , "> ***DEPRECATED***\n " )
8989 write (t , out , "> \n " )
9090 for _ , line := range grade .Message {
91- write (t , out , "> **%s**\n " , line )
91+ writef (t , out , "> **%s**\n " , line )
9292 }
9393 write (t , out , "\n " )
9494 case DocDefinitionGradeAlpha :
9595 write (t , out , "> [!WARNING]\n " )
9696 write (t , out , "> ***ALPHA***\n " )
9797 write (t , out , "> \n " )
9898 for _ , line := range grade .Message {
99- write (t , out , "> **%s**\n " , line )
99+ writef (t , out , "> **%s**\n " , line )
100100 }
101101 write (t , out , "\n " )
102102 case DocDefinitionGradeBeta :
103103 write (t , out , "> [!IMPORTANT]\n " )
104104 write (t , out , "> ***BETA***\n " )
105105 write (t , out , "> \n " )
106106 for _ , line := range grade .Message {
107- write (t , out , "> **%s**\n " , line )
107+ writef (t , out , "> **%s**\n " , line )
108108 }
109109 write (t , out , "\n " )
110110 }
111111 }
112112
113113 if d := el .Important ; d != nil {
114114 write (t , out , "> [!IMPORTANT]\n " )
115- write (t , out , "> **%s**\n \n " , * d )
115+ writef (t , out , "> **%s**\n \n " , * d )
116116 }
117117
118118 if d := el .Required ; d != nil {
119119 if * d == "" {
120120 write (t , out , "This field is **required**\n \n " )
121121 } else {
122- write (t , out , "This field is **required**: %s\n \n " , * d )
122+ writef (t , out , "This field is **required**: %s\n \n " , * d )
123123 }
124124 }
125125
126126 if len (el .Docs ) > 0 {
127127 for _ , doc := range el .Docs {
128- write (t , out , "%s\n " , doc )
128+ writef (t , out , "%s\n " , doc )
129129 }
130130 write (t , out , "\n " )
131131 }
@@ -136,9 +136,9 @@ func (d DocDefinitions) RenderMarkdown(t *testing.T, repositoryPath string) []by
136136 for _ , link := range el .Links {
137137 z := goStrings .Split (link , "|" )
138138 if len (z ) == 1 {
139- write (t , out , "* [Documentation](%s)\n " , z [0 ])
139+ writef (t , out , "* [Documentation](%s)\n " , z [0 ])
140140 } else if len (z ) == 2 {
141- write (t , out , "* [%s](%s)\n " , z [0 ], z [1 ])
141+ writef (t , out , "* [%s](%s)\n " , z [0 ], z [1 ])
142142 } else {
143143 require .Fail (t , "Invalid link format" )
144144 }
@@ -151,7 +151,7 @@ func (d DocDefinitions) RenderMarkdown(t *testing.T, repositoryPath string) []by
151151 write (t , out , "Example:\n " )
152152 write (t , out , "```yaml\n " )
153153 for _ , example := range el .Example {
154- write (t , out , "%s\n " , example )
154+ writef (t , out , "%s\n " , example )
155155 }
156156 write (t , out , "```\n \n " )
157157 }
@@ -167,25 +167,25 @@ func (d DocDefinitions) RenderMarkdown(t *testing.T, repositoryPath string) []by
167167 }
168168
169169 if len (z ) == 1 {
170- write (t , out , "* %s\n " , snip )
170+ writef (t , out , "* %s\n " , snip )
171171 } else if len (z ) == 2 {
172- write (t , out , "* %s - %s\n " , snip , z [1 ])
172+ writef (t , out , "* %s - %s\n " , snip , z [1 ])
173173 } else {
174174 require .Fail (t , "Invalid enum format" )
175175 }
176176 }
177177 write (t , out , "\n " )
178178 } else {
179179 if d := el .Default ; d != nil {
180- write (t , out , "Default Value: `%s`\n \n " , * d )
180+ writef (t , out , "Default Value: `%s`\n \n " , * d )
181181 }
182182 }
183183
184184 if d := el .Immutable ; d != nil {
185185 if * d == "" {
186186 write (t , out , "This field is **immutable**\n \n " )
187187 } else {
188- write (t , out , "This field is **immutable**: %s\n \n " , * d )
188+ writef (t , out , "This field is **immutable**: %s\n \n " , * d )
189189 }
190190 }
191191 }
@@ -545,10 +545,10 @@ func generateDocs(t *testing.T, objects map[string]map[string]interface{}, field
545545 "title" : objName ,
546546 "parent" : apiIndexPageTitle ,
547547 })
548- write (t , out , "# API Reference for %s\n \n " , objName )
548+ writef (t , out , "# API Reference for %s\n \n " , objName )
549549
550550 util .IterateSorted (renderSections , func (name string , section []byte ) {
551- write (t , out , "## %s\n \n " , util .BoolSwitch (name == "" , "Object" , name ))
551+ writef (t , out , "## %s\n \n " , util .BoolSwitch (name == "" , "Object" , name ))
552552
553553 _ , err = out .Write (section )
554554 require .NoError (t , err )
@@ -558,7 +558,12 @@ func generateDocs(t *testing.T, objects map[string]map[string]interface{}, field
558558 return outPaths
559559}
560560
561- func write (t * testing.T , out io.Writer , format string , args ... interface {}) {
561+ func write (t * testing.T , out io.Writer , format string ) {
562+ _ , err := out .Write ([]byte (format ))
563+ require .NoError (t , err )
564+ }
565+
566+ func writef (t * testing.T , out io.Writer , format string , args ... interface {}) {
562567 _ , err := out .Write ([]byte (fmt .Sprintf (format , args ... )))
563568 require .NoError (t , err )
564569}
0 commit comments