vcs
vcs copied to clipboard
Add help to, and document x.interact() on the web?
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
@davis278 where do you think this should go? It's got a nice doc string so should appear in readthedocs.