exercism/go/weather-forecast/HINTS.md

942 B

Hints

General

  • A documentation comment should be written directly before the entity that it is describing, start with the name of what it is describing, take the form of a sentence, and end with a period.

1. Document package weather

  • The package comment should be written directly before the package, start with Package x, and end with a period.

2. Document the CurrentCondition and CurrentLocation variables

  • The variable comment should be written right before the variable that it is describing, start with its name, and end with a period.

3. Document the Forecast() function

  • The function comment should come directly before the function, start with the name of the function and end with a period.