From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 06A664366A; Mon, 4 Dec 2023 11:03:32 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E47D240294; Mon, 4 Dec 2023 11:03:31 +0100 (CET) Received: from mail-ej1-f54.google.com (mail-ej1-f54.google.com [209.85.218.54]) by mails.dpdk.org (Postfix) with ESMTP id DBE2C4028C for ; Mon, 4 Dec 2023 11:03:30 +0100 (CET) Received: by mail-ej1-f54.google.com with SMTP id a640c23a62f3a-a186e5d1056so546670166b.0 for ; Mon, 04 Dec 2023 02:03:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1701684210; x=1702289010; darn=dpdk.org; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=/rnhS1AY4PEgiv/SwiYVj9qIC2OHho7scXY2zLkpMwM=; b=rcdA+1uH9leo5TwHjLJ98fHwLQSKnsEvEvVNEtiXBhi0rhwEtK3FFF4YctI/CFkIEc bZ+3LkoiAb7G0mSfh2DElqyZkzAIuaZs2ZuRGqEy8YhdJ/wrQsass3U/SEuG1a/i8HDf hwThrZIvI0WfPwLwT4KRpo0ZjzEWY27ilWrrUw3WesE0cDYSq1tx9TpZog+5of+YRM7x fsXPfU5+q0njo79bZEnBhQSPRoeSABjhsrUibDguo2Gp0XpB+WVZO/V3/drYUknBGGhn E6O49XwsSqS42q80UIMASpH2rhz+CwxnIhGL+hhW4e9zyJzYmS3ZxQ0d84p9ezZ7egku B65A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1701684210; x=1702289010; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=/rnhS1AY4PEgiv/SwiYVj9qIC2OHho7scXY2zLkpMwM=; b=DfgmtmrUMq++AlL6GA3GfOlPqs5qhHVbcjL+VIlSWMDnLNVvsRWlFeGahpDzKL9FkU eIz2DyNSNONaVvzj2eAPDk/GjGgo8eIsNeEPaoruGb50iP5bmXZ9OT15FlBaZZPlHsLl xKxjTEx6YFhcrhbM2BKj2/YiUk6GOrNbydhekogoXQbxuX6aKzVm22DlwSq/7ik/RzJD xDfmcFefBiHHOZ4Cmb6U0i++oO4gD0wQfgUwv3oQiRA5+bhEfok00vxmS3AFVX9efO4N 7iZw8YpamMyLU6B25LO9nYeRxcuslOfd0g41iss1cStbhaGeknwFOhdZvVjqd0b2JeFR g7yA== X-Gm-Message-State: AOJu0YwW6woCuAgVsof0FDnzBvvlLCkeTKbnp5vjgVPEjGmBDzKMIvIL B/geV1hVi+hHBTgaPYu+184Ye9vVvn7zMeecuAB01w== X-Google-Smtp-Source: AGHT+IEYShoPXZwrwXf4oQPZ18D+4vE2u2uwWdncpBno2FWH7LgsnfUbRrCYJX8n5HU2GyD2UJGJENPGGZW8X9mfe9w= X-Received: by 2002:a17:906:4c:b0:a04:1f99:3b48 with SMTP id 12-20020a170906004c00b00a041f993b48mr3138445ejg.74.1701684210533; Mon, 04 Dec 2023 02:03:30 -0800 (PST) MIME-Version: 1.0 References: <20231115130959.39420-1-juraj.linkes@pantheon.tech> <20231123151344.162812-1-juraj.linkes@pantheon.tech> <20231123151344.162812-20-juraj.linkes@pantheon.tech> In-Reply-To: From: =?UTF-8?Q?Juraj_Linke=C5=A1?= Date: Mon, 4 Dec 2023 11:03:19 +0100 Message-ID: Subject: Re: [PATCH v8 19/21] dts: base traffic generators docstring update To: Jeremy Spewock Cc: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, probb@iol.unh.edu, paul.szczepanek@arm.com, yoan.picchi@foss.arm.com, Luca.Vizzarro@arm.com, dev@dpdk.org Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On Fri, Dec 1, 2023 at 7:05=E2=80=AFPM Jeremy Spewock wrote: > > > > On Thu, Nov 23, 2023 at 10:14=E2=80=AFAM Juraj Linke=C5=A1 wrote: >> >> Format according to the Google format and PEP257, with slight >> deviations. >> >> Signed-off-by: Juraj Linke=C5=A1 >> --- >> .../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 >> @@ -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 p= ackets >> - 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.