Additional doc comments for billing map keys

google · Dec 14, 2022 · c897aa1 · c897aa1
1 parent f666662
commit c897aa1
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/github/actions_workflow_runs.go b/github/actions_workflow_runs.go
@@ -70,6 +70,7 @@ type WorkflowRunUsage struct {
 }
 
 // WorkflowRunBillMap represents different runner environments available for a workflow run.
+// Its key is the name of its environment, e.g. "UBUNTU", "MACOS", "WINDOWS", etc.
 type WorkflowRunBillMap map[string]*WorkflowRunBill
 
 // WorkflowRunBill specifies billable time for a specific environment in a workflow run.

diff --git a/github/actions_workflows.go b/github/actions_workflows.go
@@ -36,6 +36,7 @@ type WorkflowUsage struct {
 }
 
 // WorkflowBillMap represents different runner environments available for a workflow.
+// Its key is the name of its environment, e.g. "UBUNTU", "MACOS", "WINDOWS", etc.
 type WorkflowBillMap map[string]*WorkflowBill
 
 // WorkflowBill specifies billable time for a specific environment in a workflow.

diff --git a/github/billing.go b/github/billing.go
@@ -24,6 +24,7 @@ type ActionBilling struct {
 	MinutesUsedBreakdown MinutesUsedBreakdown `json:"minutes_used_breakdown"`
 }
 
+// MinutesUsedBreakdown counts the actions minutes used by machine type (e.g. UBUNTU, WINDOWS, MACOS).
 type MinutesUsedBreakdown = map[string]int
 
 // PackageBilling represents a GitHub Package billing.