Skip to content

Commit

Permalink
update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ba2tro committed Dec 6, 2024
1 parent 3dbd8aa commit b61b6b6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions src/ProtocolZoo/controllers.jl
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ end
$TYPEDEF
A network control protocol that is connection oriented, non-distributed and centralized. The controller is located at one of the nodes in the network from where it messages all
the other nodes' [`RequestTracker`](@ref) protocols when it receives [`DistributionRequest`](@ref) from the [`RequestGenerator`](@ref).
the other nodes' [`RequestTracker`](@ref) protocols when it receives [`DistributionRequest`](@ref) from [`RequestGeneratorCO`](@ref).
$TYPEDFIELDS
See also [`RequestGenerator`](@ref), [`RequestTracker`](@ref)
See also [`RequestGeneratorCO`](@ref), [`RequestGeneratorCL`](@ref), [`RequestTracker`](@ref)
"""
@kwdef struct Controller <: AbstractProtocol
"""Time-and-schedule-tracking instance from `ConcurrentSim`"""
Expand Down Expand Up @@ -124,11 +124,11 @@ end
$TYPEDEF
A network control protocol that is connection less, non-distributed and centralized. The controller is located at one of the nodes in the network from where it messages all
the other nodes' [`RequestTracker`](@ref) protocols when it receives [`DistributionRequest`](@ref) from the [`RequestGenerator`](@ref).
the other nodes' [`RequestTracker`](@ref) protocols when it receives [`DistributionRequest`](@ref) from the [`RequestGeneratorCL`](@ref).
$TYPEDFIELDS
See also [`RequestGenerator`](@ref), [`RequestTracker`](@ref)
See also [`RequestGeneratorCO`](@ref), [`RequestGeneratorCL`](@ref), [`RequestTracker`](@ref)
"""
@kwdef struct CLController <: AbstractProtocol
"""Time-and-schedule-tracking instance from `ConcurrentSim`"""
Expand Down
2 changes: 1 addition & 1 deletion src/ProtocolZoo/utils.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
$TYPEDEF
A struct containing the physical graph metadata for a network. The latest workload data is only available
at the node where the [`RequestGenerator`](@ref) runs, but every node has access to a copy for referencing paths based on indices
at the node where the [`Controller`](@ref) runs, but every node has access to a copy for referencing paths based on indices
passed through the `DistributionRequest` tag/message.
$TYPEDFIELDS
Expand Down

0 comments on commit b61b6b6

Please sign in to comment.