openapi3: fix deprecation comments

alexandear · alexandear · commit 77c9602b5621 · 2024-11-26T18:54:49.000+02:00
diff --git a/.github/docs/openapi3.txt b/.github/docs/openapi3.txt
@@ -128,13 +128,16 @@ func DefineNumberFormatValidator(name string, validator NumberFormatValidator)
     number format.
 
 func DefineStringFormat(name string, pattern string)
-    DefineStringFormat defines a regexp pattern for a given string
-    format Deprecated: Use openapi3.DefineStringFormatValidator(name,
+    DefineStringFormat defines a regexp pattern for a given string format
+
+    Deprecated: Use openapi3.DefineStringFormatValidator(name,
     NewRegexpFormatValidator(pattern)) instead.
 
 func DefineStringFormatCallback(name string, callback func(string) error)
-    DefineStringFormatCallback defines a callback function for a given
-    string format Deprecated: Use openapi3.DefineStringFormatValidator(name,
+    DefineStringFormatCallback defines a callback function for a given string
+    format
+
+    Deprecated: Use openapi3.DefineStringFormatValidator(name,
     NewCallbackValidator(fn)) instead.
 
 func DefineStringFormatValidator(name string, validator StringFormatValidator)
diff --git a/openapi3/schema_formats.go b/openapi3/schema_formats.go
@@ -131,12 +131,14 @@ func DefineIntegerFormatValidator(name string, validator IntegerFormatValidator)
 }
 
 // DefineStringFormat defines a regexp pattern for a given string format
+//
 // Deprecated: Use openapi3.DefineStringFormatValidator(name, NewRegexpFormatValidator(pattern)) instead.
 func DefineStringFormat(name string, pattern string) {
 	DefineStringFormatValidator(name, NewRegexpFormatValidator(pattern))
 }
 
 // DefineStringFormatCallback defines a callback function for a given string format
+//
 // Deprecated: Use openapi3.DefineStringFormatValidator(name, NewCallbackValidator(fn)) instead.
 func DefineStringFormatCallback(name string, callback func(string) error) {
 	DefineStringFormatValidator(name, NewCallbackValidator(callback))

Original file line number	Diff line number	Diff line change
`@@ -131,12 +131,14 @@ func DefineIntegerFormatValidator(name string, validator IntegerFormatValidator)`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`// DefineStringFormat defines a regexp pattern for a given string format`
	`134`	`+//`
`134`	`135`	`// Deprecated: Use openapi3.DefineStringFormatValidator(name, NewRegexpFormatValidator(pattern)) instead.`
`135`	`136`	`func DefineStringFormat(name string, pattern string) {`
`136`	`137`	`DefineStringFormatValidator(name, NewRegexpFormatValidator(pattern))`
`137`	`138`	`}`
`138`	`139`
`139`	`140`	`// DefineStringFormatCallback defines a callback function for a given string format`
	`141`	`+//`
`140`	`142`	`// Deprecated: Use openapi3.DefineStringFormatValidator(name, NewCallbackValidator(fn)) instead.`
`141`	`143`	`func DefineStringFormatCallback(name string, callback func(string) error) {`
`142`	`144`	`DefineStringFormatValidator(name, NewCallbackValidator(callback))`