Re: [gentoo-catalyst] [PATCH 02/37] catalyst: Drop outdated comment

[Matt Turner]

On Tue, Oct 20, 2020 at 8:02 PM Brian Dolbec <dolsen@g.o> wrote:
>
> On Tue, 20 Oct 2020 17:23:09 -0700
> Matt Turner <mattst88@g.o> wrote:
>
> > We don't use os.system anymore. We pass self.env to Popen, so the
> > comment isn't accurate.
> >
> > Signed-off-by: Matt Turner <mattst88@g.o>
> > ---
> >  catalyst/base/stagebase.py | 5 -----
> >  1 file changed, 5 deletions(-)
> >
> > diff --git a/catalyst/base/stagebase.py b/catalyst/base/stagebase.py
> > index 48157837..532f7133 100644
> > --- a/catalyst/base/stagebase.py
> > +++ b/catalyst/base/stagebase.py
> > @@ -1307,11 +1307,6 @@ class StageBase(TargetBase, ClearBase,
> > GenBase): print_traceback=False)
> >
> >      def setup_environment(self):
> > -        """
> > -        Modify the current environment. This is an ugly hack that
> > should be
> > -        fixed. We need this to use the os.system() call since we
> > can't
> > -        specify our own environ
> > -        """
> >          log.debug('setup_environment(); settings = %r',
> > self.settings) for x in list(self.settings):
> >              log.debug('setup_environment(); processing: %s', x)
>
>
> Instead of deleting the entire docstring, change it to reflect the
> correct info.  ‌pylint will bitch about the lack of a docstring.

We're missing docstrings almost everywhere and have the pylint warning
disabled. From .pylintrc:

# We should clean up things so we can enable:
# missing-docstring -- add lots of docstrings everywhere!
[...]
disable=
    missing-docstring,
    [...]

I'm going to leave this as is for now.