Menu ▾ ▴

#207 Make Python Terminal more intuitive

v_1.2.0
open
nobody
Commands / Extensions (68)
5
2012-09-12
2010-04-23
Konstantin Tokarev
No

Python terminal should be usable (at least on simplest level) without referencing to documentation. It would be nice to have some in-place help, what objects/commands are possible to use. For example, in Matlab one can click near command prompt and get complete list of available functions. In bash one can make double tab and get list of available programs.

Discussion

  • Tim Vandermeersch

    Tim Vandermeersch - 2010-04-23

    The functions are documented in python. The native python help(Avogadro) can be used to access this information...

     

  • Konstantin Tokarev

    Konstantin Tokarev - 2010-04-25

    1. It works, but it's needed to import Avogadro first. It should be already done when I open terminal. Also, user may not know, what to type: Avogadro, avogadro (personally I've started with it) or may be AVOGADRO. He may even be not aware of case-sensitivity. So it would be nice to type 'help' and get it (and have a prompt on top "type 'help' to get help")

    2. help(Avogadro) output is too big to read in small window, some sort of quick start will be preferable. Maybe it's possible to define custom Python function or simply search for 'help' in input before passing it to Python?

    3. Correct me if I'm wrong. AFAIU, Python Terminal is intended for user interaction with molecules and scene elements, not for such boring things as "programming" and "debug" :) So, it should be possible to use it in manner "try&learn", without reading books? manuals, etc. Of course, it may be needed for complex tasks, but Avogadro must contain everything to help user make first steps without any external manuals. Maybe for you its self evident (because you're proficient in Python), but others may need to learn it.