From 38e1065b2470b7ad15df90aefb653657402729b8 Mon Sep 17 00:00:00 2001 From: "Michael B. Gale" Date: Wed, 15 May 2024 09:38:31 +0100 Subject: [PATCH] Go: Document return values for `Autobuild` --- go/extractor/autobuilder/autobuilder.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/go/extractor/autobuilder/autobuilder.go b/go/extractor/autobuilder/autobuilder.go index 9ad52c5b1da..b9405a764d4 100644 --- a/go/extractor/autobuilder/autobuilder.go +++ b/go/extractor/autobuilder/autobuilder.go @@ -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{}