docs: add docs to CB
Pretty much every class and method should have documentation now. ref: N25B-295
This commit is contained in:
@@ -2,12 +2,29 @@ from pydantic import BaseModel
|
||||
|
||||
|
||||
class Norm(BaseModel):
|
||||
"""
|
||||
Represents a behavioral norm.
|
||||
|
||||
:ivar id: Unique identifier.
|
||||
:ivar label: Human-readable label.
|
||||
:ivar norm: The actual norm text describing the behavior.
|
||||
"""
|
||||
|
||||
id: str
|
||||
label: str
|
||||
norm: str
|
||||
|
||||
|
||||
class Goal(BaseModel):
|
||||
"""
|
||||
Represents an objective to be achieved.
|
||||
|
||||
:ivar id: Unique identifier.
|
||||
:ivar label: Human-readable label.
|
||||
:ivar description: Detailed description of the goal.
|
||||
:ivar achieved: Status flag indicating if the goal has been met.
|
||||
"""
|
||||
|
||||
id: str
|
||||
label: str
|
||||
description: str
|
||||
@@ -27,6 +44,16 @@ class KeywordTrigger(BaseModel):
|
||||
|
||||
|
||||
class Phase(BaseModel):
|
||||
"""
|
||||
A distinct phase within a program, containing norms, goals, and triggers.
|
||||
|
||||
:ivar id: Unique identifier.
|
||||
:ivar label: Human-readable label.
|
||||
:ivar norms: List of norms active in this phase.
|
||||
:ivar goals: List of goals to pursue in this phase.
|
||||
:ivar triggers: List of triggers that define transitions out of this phase.
|
||||
"""
|
||||
|
||||
id: str
|
||||
label: str
|
||||
norms: list[Norm]
|
||||
@@ -35,4 +62,10 @@ class Phase(BaseModel):
|
||||
|
||||
|
||||
class Program(BaseModel):
|
||||
"""
|
||||
Represents a complete interaction program, consisting of a sequence or set of phases.
|
||||
|
||||
:ivar phases: The list of phases that make up the program.
|
||||
"""
|
||||
|
||||
phases: list[Phase]
|
||||
|
||||
Reference in New Issue
Block a user