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 24ED14366A; Mon, 4 Dec 2023 11:02:34 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A279C40294; Mon, 4 Dec 2023 11:02:33 +0100 (CET) Received: from mail-ej1-f43.google.com (mail-ej1-f43.google.com [209.85.218.43]) by mails.dpdk.org (Postfix) with ESMTP id 44DEA4028C for ; Mon, 4 Dec 2023 11:02:32 +0100 (CET) Received: by mail-ej1-f43.google.com with SMTP id a640c23a62f3a-9e1021dbd28so583320766b.3 for ; Mon, 04 Dec 2023 02:02:32 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1701684152; x=1702288952; 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=EP76B43Qy+9Nk3tJNafGO26d4754mA2V1JBvs4osmT8=; b=eqZjfkCUP4B320jKpyRq7fr+l5fLlTSC9ALfGA512XimS2Dqq4IokT+cGuL/uacxqa A0w3ukHKvX1re0FWmFf1Snilyx65tOSVDCRL7pq2kj3+QCl6fQGnhvFLhed+HzRZUKT4 Po8/zpsbWAYhEf8zalFCbqvP//acw5/kIwWYg29URforrgd1DIXwyG1JZsbHu0mQ8gu+ 5eabqCWFLNCVWZtT1Yk5U5LDm40TfglGn+aPaSAUf5AFEeS9uVfvz1BW0UCWdYJrOkY3 JwvSmoAoXj6j0x3ATAy1XVagR6AwJHXlKTzY+9sb8fAF/7eXTrHhDnzlecJyZX56Rt+f AWrw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1701684152; x=1702288952; 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=EP76B43Qy+9Nk3tJNafGO26d4754mA2V1JBvs4osmT8=; b=be/5R+H6ratzgmp+V0Muo9rQy3xXMKyCidbV/If+7/HXJPN9pWIdJU5Dq6Do/VcHOO kBCqA+IFRWHbqyHaN/6Ab0rUkDHIPJ0qSLgi8pChrSAzIUzwqKmvhAs9wP4MM24MBPLT EoTmBR4L2yiMk1KrEDa3n/81d/btXPU3Hf3F/QHGx2FTKnQ46FmZtHsnTwVmpMERLWCh L4M+krBnTCmoCw8HM3SDQ1C5e5AGdS2mzOtR7x6V+JhWoVLEGLCrcuj2ejnZ53I18Ron 49ul9l//fDqF8FS6ez9NoN7HDT1nzBnw6GAmoQCzUHvwBDtCTW7MlX8KzDMHqji466su iUXw== X-Gm-Message-State: AOJu0YzVmkZRgzLSU2AVD0CQlGNIIcDD12lQjd+vXRdYNw8t3gN7t9Nd CJ9fao3R58mGynOhnn3KuJPekyxyKZeDy4A7OeBzrg== X-Google-Smtp-Source: AGHT+IFEeVB9X6/nzly0OGJP+Rz0DuesycEncRRTGj9LX46V9cZvH6MMIvMbtvAWNxaBjpq5ey5trow0eCtbSEZZb4c= X-Received: by 2002:a17:907:511:b0:a19:a19b:c724 with SMTP id wj17-20020a170907051100b00a19a19bc724mr2629195ejb.116.1701684151775; Mon, 04 Dec 2023 02:02:31 -0800 (PST) MIME-Version: 1.0 References: <20231115130959.39420-1-juraj.linkes@pantheon.tech> <20231123151344.162812-1-juraj.linkes@pantheon.tech> <20231123151344.162812-19-juraj.linkes@pantheon.tech> In-Reply-To: From: =?UTF-8?Q?Juraj_Linke=C5=A1?= Date: Mon, 4 Dec 2023 11:02:21 +0100 Message-ID: Subject: Re: [PATCH v8 18/21] dts: sut and tg nodes 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:06=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 >> --- >> dts/framework/testbed_model/sut_node.py | 230 ++++++++++++++++-------- >> dts/framework/testbed_model/tg_node.py | 42 +++-- >> 2 files changed, 176 insertions(+), 96 deletions(-) >> >> diff --git a/dts/framework/testbed_model/sut_node.py b/dts/framework/tes= tbed_model/sut_node.py >> index 5ce9446dba..c4acea38d1 100644 >> --- a/dts/framework/testbed_model/sut_node.py >> +++ b/dts/framework/testbed_model/sut_node.py >> @@ -3,6 +3,14 @@ >> # Copyright(c) 2023 PANTHEON.tech s.r.o. >> # Copyright(c) 2023 University of New Hampshire >> >> +"""System under test (DPDK + hardware) node. >> + >> +A system under test (SUT) is the combination of DPDK >> +and the hardware we're testing with DPDK (NICs, crypto and other device= s). >> +An SUT node is where this SUT runs. >> +""" > > > I think this should just be "A SUT node" > I always spell it out which is why I used "an" (an es, ju:, ti: node). >From what I understand, the article is based on how the word is pronounced. If it's an initialism (it's spelled), we should use "an" and if it's an abbreviation (pronounced as the whole word), we should use "a". It always made sense to me as an initialism - I think that's the common usage.