[PATCH v8 19/21] dts: base traffic generators docstring update

[Juraj Linkeš]

On Fri, Dec 1, 2023 at 7:05 PM Jeremy Spewock <jspewock at iol.unh.edu> wrote:
>
>
>
> On Thu, Nov 23, 2023 at 10:14 AM Juraj Linkeš <juraj.linkes at pantheon.tech> wrote:
>>
>> Format according to the Google format and PEP257, with slight
>> deviations.
>>
>> Signed-off-by: Juraj Linkeš <juraj.linkes at pantheon.tech>
>> ---
>>  .../traffic_generator/__init__.py             | 22 ++++++++-
>>  .../capturing_traffic_generator.py            | 45 +++++++++++--------
>>  .../traffic_generator/traffic_generator.py    | 33 ++++++++------
>>  3 files changed, 67 insertions(+), 33 deletions(-)
>>
>> diff --git a/dts/framework/testbed_model/traffic_generator/__init__.py b/dts/framework/testbed_model/traffic_generator/__init__.py
>> index 52888d03fa..11e2bd7d97 100644
>> --- a/dts/framework/testbed_model/traffic_generator/__init__.py
>> +++ b/dts/framework/testbed_model/traffic_generator/__init__.py
<snip>
>> @@ -60,19 +67,17 @@ def send_packets(self, packets: list[Packet], port: Port) -> None:
>>
>>      @abstractmethod
>>      def _send_packets(self, packets: list[Packet], port: Port) -> None:
>> -        """
>> -        The extended classes must implement this method which
>> -        sends packets on send_port. The method should block until all packets
>> -        are fully sent.
>> +        """The implementation of :method:`send_packets`.
>> +
>> +        The subclasses must implement this method which sends `packets` on `port`.
>> +        The method should block until all `packets` are fully sent.
>> +
>> +        What full sent means is defined by the traffic generator.
>>          """
>
>
> I think this should be "what fully sent means"
>

Thanks, Yoan also caught this.