search

firebase / firebase-admin-go

Firebase Admin Go SDK
Apache License 2.0
1.13k stars 242 forks source link

add DEPRECATED labels on godoc #469

Closed shogo82148 closed 1 year ago

shogo82148 commented 2 years ago

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

lahirumaramba commented 1 year ago

Duplicate of #531