Ensure all documentation comments follow proper formatting conventions and are placed where developers will most likely read them. Documentation should use correct grammar, complete sentences, and end with periods. Additionally, place documentation at the most relevant location - typically at interface definitions rather than implementation details, since developers read interface documentation when implementing methods.
Example of proper formatting:
// ErrTimeout is a fake timeout error.
var ErrTimeout = errors.New("timeout")
Example of proper placement: Place WriteTo documentation at the WriterTo interface definition, not at Copy function implementation, because developers implementing WriteTo will read the interface documentation, not the Copy function documentation.
Enter the URL of a public GitHub repository