You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
@tsl0922 Is this only a documentation enhancement? As in, whereever there is a deprecated proto field, guarantee that the generated pb.go file explicitly documents fields as "Deprecated:" like mentioned in that article. Is there something else to it?
That should be it. golang/go#10909 documents "Deprecated:" as special. Tools like golint and godoc will treat deprecated specially by either warning on their usage or hiding them from documentation (golang/go#17056).
Syntax:
https://blog.golang.org/godoc-documenting-go-code
The text was updated successfully, but these errors were encountered: