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

Add help to, and document x.interact() on the web? #144

Open
jypeter opened this issue Mar 10, 2017 · 1 comment
Open

Add help to, and document x.interact() on the web? #144

jypeter opened this issue Mar 10, 2017 · 1 comment
Milestone

Comments

@jypeter
Copy link
Member

jypeter commented Mar 10, 2017

x.interact() is quite important if you want to do some interactive work with vcs (in my case resize the canvas, click on the cells to check their values), but:

  • there is no docstring (we may be able to live with that)
Help on method interact in module vcs.Canvas:

interact(self, *args, **kargs) method of vcs.Canvas.Canvas instance
(END)
  • there is no help at all about that on the web site (or at least none I found after spending my morning checking the web site). A Google search of "uvcdat interact()" did not yield any information that would help an end-user. How is a new spontaneous (e.g. not from a place where there are already vcs users) user supposed to learn about that?

I like the fact that I get a reminder message that I can leave the interact mode by typing 'q' in the canvas. I wonder if you should display a message about interact when x.init() is called, but only in an interactive session (if this can be detected)

Of course, it would be better if I did not need x.interact() + q and I could interact with the interpreter and the canvases at the same time, like in the (good) old times but it seems I have to forget about that

@doutriaux1 doutriaux1 modified the milestone: 3.0 May 5, 2017
@doutriaux1 doutriaux1 modified the milestones: 3.0, post 3.0 Mar 29, 2018
@doutriaux1 doutriaux1 modified the milestones: 8.1, 8.2 Mar 27, 2019
@doutriaux1
Copy link
Contributor

@davis278 where do you think this should go? It's got a nice doc string so should appear in readthedocs.

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

2 participants