Additional doc comments for billing map keys

James Turley · James Turley · commit f23195166294 · 2022-12-14T16:23:26.000Z
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.

Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,7 @@ type WorkflowRunUsage struct {`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`// WorkflowRunBillMap represents different runner environments available for a workflow run.`
	`73`	`+// Its key is the name of its environment, e.g. "UBUNTU", "MACOS", "WINDOWS", etc.`
`73`	`74`	`type WorkflowRunBillMap map[string]*WorkflowRunBill`
`74`	`75`
`75`	`76`	`// WorkflowRunBill specifies billable time for a specific environment in a workflow run.`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ type WorkflowUsage struct {`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`// WorkflowBillMap represents different runner environments available for a workflow.`
	`39`	`+// Its key is the name of its environment, e.g. "UBUNTU", "MACOS", "WINDOWS", etc.`
`39`	`40`	`type WorkflowBillMap map[string]*WorkflowBill`
`40`	`41`
`41`	`42`	`// WorkflowBill specifies billable time for a specific environment in a workflow.`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ type ActionBilling struct {`
`24`	`24`	MinutesUsedBreakdown MinutesUsedBreakdown `json:"minutes_used_breakdown"`
`25`	`25`	`}`
`26`	`26`
	`27`	`+// MinutesUsedBreakdown counts the actions minutes used by machine type (e.g. UBUNTU, WINDOWS, MACOS).`
`27`	`28`	`type MinutesUsedBreakdown = map[string]int`
`28`	`29`
`29`	`30`	`// PackageBilling represents a GitHub Package billing.`