flag: clarify that the main func at pkg.go.dev is part of a testing suite

flag.Example() has this comment:
    ... one must execute, typically at the start of main (not init!):
      flag.Parse()
    We don't run it here because this is not a main function

This example function will be renamed to "main" at pkg.go.dev, which
makes the comment confusing.
See https://pkg.go.dev/flag#example-package.

This change modify the comment to clarify this situation.
This commit is contained in:
Zeke Lu 2022-10-26 07:05:44 +08:00
parent 15fc09d440
commit eeea8ce39c
1 changed files with 4 additions and 3 deletions

View File

@ -78,7 +78,8 @@ func Example() {
// to enable the flag package to see the flags defined there, one must
// execute, typically at the start of main (not init!):
// flag.Parse()
// We don't run it here because this is not a main function (it's renamed to
// "main" in playground, but bear in mind that this is a test example) and
// the testing suite has already parsed the flags.
// We don't call it here because this code is a function called "Example"
// that is part of the testing suite for the package, which has already
// parsed the flags. When viewed at pkg.go.dev, however, the function is
// renamed to "main" and it could be run as a standalone example.
}