echo-contrib icon indicating copy to clipboard operation
echo-contrib copied to clipboard

Fix the deprecation comment format

Open gnvk opened this issue 8 months ago • 0 comments

According to the Go WIKI

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, and a recommendation on what to use instead, if applicable.

Emphasis is mine. Without putting the "Deprecated:" part to its own paragraph, automated tools and IDEs (e.g. vscode) don't recognize the deprecation warning.

gnvk avatar May 17 '25 09:05 gnvk