Go: Document return values for Autobuild

This commit is contained in:
Michael B. Gale
2024-05-15 09:38:31 +01:00
parent 65c654e946
commit 38e1065b24

View File

@@ -94,6 +94,8 @@ var BuildScripts = []BuildScript{
// Autobuild attempts to detect build systems based on the presence of build scripts from the
// list in `BuildScripts` and run the corresponding command. This may invoke zero or more
// build scripts in the order given by `BuildScripts`.
// Returns `scriptSuccess` which indicates whether a build script was successfully executed.
// Returns `scriptsExecuted` which contains the names of all build scripts that were executed.
func Autobuild() (scriptSuccess bool, scriptsExecuted []string) {
scriptSuccess = false
scriptsExecuted = []string{}