Skip to content

Commit 057c96a

Browse files
Copilotknopers8
andcommitted
Complete package documentation for all remaining packages
Co-authored-by: knopers8 <[email protected]>
1 parent e09e45d commit 057c96a

File tree

10 files changed

+20
-0
lines changed

10 files changed

+20
-0
lines changed

core/task/channel/inbound.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package channel provides functionality for managing task communication channels,
26+
// including inbound and outbound channel configuration and message routing.
2527
package channel
2628

2729
import (

core/task/schedutil/mesosutil.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
* Intergovernmental Organization or submit itself to any jurisdiction.
2626
*/
2727

28+
// Package schedutil provides scheduler utility functions for Apache Mesos
29+
// integration, including resource management and task scheduling helpers.
2830
package schedutil
2931

3032
import (

core/task/sm/machine.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package sm provides state machine functionality for task lifecycle management,
26+
// including state transitions and event handling.
2527
package sm
2628

2729
type Transition struct {

core/task/taskclass/port/range.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package port provides port range management functionality for task
26+
// communication, including port range parsing and validation.
2527
package port
2628

2729
import (

core/task/taskclass/resourcelimits.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package taskclass provides task class definitions and resource management
26+
// for different types of tasks in the O² Control system.
2527
package taskclass
2628

2729
import "strconv"

core/task/taskop/messagetype.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package taskop provides task operation types and message handling functionality
26+
// for controlling task lifecycle and communication.
2527
package taskop
2628

2729
import (

core/the/eventwriter.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package the provides global event handling and state management for
26+
// the core system, including event writers and system-wide notifications.
2527
package the
2628

2729
import (

core/workflow/callable/utils.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// Package callable provides utility functions for workflow callable operations,
2+
// including timeout handling and trigger expression parsing.
13
package callable
24

35
import (

executor/executorcmd/nopb/jsoncodec.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package nopb provides non-protobuf encoding functionality including
26+
// JSON codec implementations for gRPC communication.
2527
package nopb
2628

2729
import (

executor/executorcmd/transitioner/direct.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* Intergovernmental Organization or submit itself to any jurisdiction.
2323
*/
2424

25+
// Package transitioner provides transition management functionality for
26+
// handling task state transitions with different transition strategies.
2527
package transitioner
2628

2729
type Direct struct {

0 commit comments

Comments
 (0)