api: added design comment on Ae.API*() methods

aeternity · Feb 19, 2019 · 5762cbf · 5762cbf
1 parent ccdf565
commit 5762cbf
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/aeternity/api.go b/aeternity/api.go
@@ -8,6 +8,9 @@ import (
 	"github.com/aeternity/aepp-sdk-go/generated/models"
 )
 
+// Ae.API*() methods are the stable interface to Go code that uses this SDK.
+// Logic implementation is handled by the unexported functions.
+
 // APIGetStatus post transaction
 func (ae *Ae) APIGetStatus() (status *models.Status, err error) {
 	return getStatus(ae.Epoch)