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

Docstring and argument should be available by shift-tab in the notebook #90

Closed
MerlinSmiles opened this issue Apr 20, 2016 · 5 comments
Closed

Comments

@MerlinSmiles
Copy link
Contributor

Related to my last comment in #78.

From the user perspective, this is an important issue and will determine how effective users actually use the code.

The docstrings of functions have to somehow magically go through the processes stuff, but it is actually needed for all important things in the notebook, at any point, I as a user want to do shift tab and see what that function does.

The same goes for available arguments, I only figured out that update=True exists for the snapshot by digging through the code on my way to figure out where to implement it, we cannot expect this from a regular user.

@AdriaanRol
Copy link
Contributor

Are they not? I use this on a daily basis in QCodes, or is this related to the recent change in using the servers to host instruments? If so then I'd say this is quite a big usability issue.

@MerlinSmiles
Copy link
Contributor Author

No, i.e. station.snapshot(<shift><tab>) shows me *args, **kwargs

image

I would have never figured out that update=True existed without digging through all the code, including the multiprocessing.

@MerlinSmiles
Copy link
Contributor Author

Maybe something like this is what we need, or the one that is linked to in the header. Might not work with that remote stuff, but for a lot of other things.

@MerlinSmiles
Copy link
Contributor Author

It would also be nice to have the arguments, a lot of *args and **kwargs are in the code, which doesn't help the user a lot.

@giulioungaretti
Copy link
Contributor

This is probably been fixed along the way.
Qcodes had a *args, **kwargs abuse problem that we fixed little by tittle.

@MerlinSmiles you fixed it (8926f45)

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

No branches or pull requests

4 participants