From b61b6b6b5504f21b0c8e809e1bb65f70859a1f76 Mon Sep 17 00:00:00 2001 From: Abhishek Bhatt Date: Fri, 6 Dec 2024 14:07:41 -0500 Subject: [PATCH] update docstrings --- src/ProtocolZoo/controllers.jl | 8 ++++---- src/ProtocolZoo/utils.jl | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/ProtocolZoo/controllers.jl b/src/ProtocolZoo/controllers.jl index 9945c15d..ebd86ac9 100644 --- a/src/ProtocolZoo/controllers.jl +++ b/src/ProtocolZoo/controllers.jl @@ -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`""" @@ -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`""" diff --git a/src/ProtocolZoo/utils.jl b/src/ProtocolZoo/utils.jl index d1bac7b7..76750b93 100644 --- a/src/ProtocolZoo/utils.jl +++ b/src/ProtocolZoo/utils.jl @@ -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