Remove get_description() from interface

[khsrali]

Fixes:
#58

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.43%. Comparing base (151e5a6) to head (c65d997).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #59      +/-   ##
==========================================
+ Coverage   79.32%   79.43%   +0.11%     
==========================================
  Files           4        4              
  Lines         677      671       -6     
==========================================
- Hits          537      533       -4     
+ Misses        140      138       -2     

Flag	Coverage Δ
pytests	79.43% <ø> (+0.11%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[agoscinski]

Have you considered overwriting class variable __doc__? Then you can in principle also include this if you can retrieve auth_options is from another class

class AuthoptionHolder:
    auth_options = {"machine": "the name of the machine"}

class A:
    __doc__ = ( """Transport interface for FirecREST.
    It must be used together with the 'firecrest' scheduler plugin."""
    +
    "Authentication parameters:\n"
        ) + "\n".join(
            [f"  {k}: {v}" for k, v in AuthoptionHolder.auth_options.items()]
        )

A.__doc__

[khsrali]

Thanks @agoscinski , it's interesting.
But it doesn't work, because auth_options should be from the current class cls, not the one we inherit from.
So it easily turns into some fuss: one has to assign put the __doc__ after _valid_auth_options, and do some list/tuple/dict magic to take the info out.

Probably it's not that important. I don't thing if many people would like to see inputs of a class through verdi plugin list anyways.

[agoscinski]

I think the description is not so important, but class documentation I think is important, since you get it with help(<CLASS_NAME>). But my solution also complexifies code logic so I am ok to not do it.

[khsrali]

thanks for the review, @agoscinski