firebase-admin-go icon indicating copy to clipboard operation
firebase-admin-go copied to clipboard

add DEPRECATED labels on godoc

Open shogo82148 opened this issue 3 years ago • 0 comments
trafficstars

godoc accepts “Deprecated:” comments as a depected feature.

https://go.dev/blog/godoc

Sometimes a struct field, function, type, or even a whole package becomes redundant or unnecessary, but must be kept for compatibility with existing programs. To signal that an identifier should not be used, add a paragraph to its doc comment that begins with “Deprecated:” followed by some information about the deprecation.

For example, https://pkg.go.dev/net/http/httputil#ClientConn

image

shogo82148 avatar Nov 25 '21 02:11 shogo82148