[PATCH v6 06/23] dts: logger and settings docstring update

[Juraj Linkeš]

On Wed, Nov 8, 2023 at 6:14 PM Yoan Picchi <yoan.picchi at foss.arm.com> wrote:
>
> On 11/8/23 12:53, Juraj Linkeš wrote:
> > Format according to the Google format and PEP257, with slight
> > deviations.
> >
> > Signed-off-by: Juraj Linkeš <juraj.linkes at pantheon.tech>
> > ---
> >   dts/framework/logger.py | 72 +++++++++++++++++++++----------
> >   dts/framework/utils.py  | 96 ++++++++++++++++++++++++++++++-----------
> >   2 files changed, 121 insertions(+), 47 deletions(-)
> >

<snip>

> > diff --git a/dts/framework/utils.py b/dts/framework/utils.py
> > index f0c916471c..0613adf7ad 100644
> > --- a/dts/framework/utils.py
> > +++ b/dts/framework/utils.py
<snip>
> > @@ -93,35 +129,33 @@ class _TarCompressionFormat(StrEnum):
> >       and Enum values are the associated file extensions.
> >       """
> >
> > +    #:
> >       gzip = "gz"
> > +    #:
> >       compress = "Z"
> > +    #:
> >       bzip2 = "bz2"
> > +    #:
> >       lzip = "lz"
> > +    #:
> >       lzma = "lzma"
> > +    #:
> >       lzop = "lzo"
> > +    #:
> >       xz = "xz"
> > +    #:
> >       zstd = "zst"
>
> Just to be sure, _TarCompressionFormat doesn't appear in the doc
> (framework.utils.html). I believe that's intended (because of the _) but
> then I don't think the #: are used for anything.
>

Good point, I'll remove the comments as they're just clutter when not
in doc generation.