Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include inherited methods for instruments (mixin preparation) #1060

Open
BenediktBurger opened this issue Mar 11, 2024 · 0 comments
Open

Include inherited methods for instruments (mixin preparation) #1060

BenediktBurger opened this issue Mar 11, 2024 · 0 comments

Comments

@BenediktBurger
Copy link
Member

          I'd include a task for updating driver documentation `.rst` files for all drivers to inherit `SCPImixin` so the SCPI properties are included on their instrument driver page. Let me know if you'd like to split up the tasks.

For instance, for class SomeSCPIinst(SCPImixin, Instrument), the following would inherit properties for documentation up to Instrument, so Instrument isn't included but SCPImixin functionality is:

#########################
Some SCPI inst
#########################

.. autoclass:: pymeasure.instruments.example.SomeSCPIinst
    :members:
    :show-inheritance:
    :inherited-members: Instrument

Originally posted by @mcdo0486 in #905 (comment)

I propose to add this line to all classes, such that they will show methods inherited by their mixins, whichever might come.

One point, though: "show-inheritance" will show all these parent classes, such that you could check them in order to get the methods.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant