search

OpenTechSchool / python-beginners

Workshop material for "Introduction to Programming with Python"
http://opentechschool.github.io/python-beginners/
175 stars 253 forks source link

help() is confusing #11

Closed nekopanic closed 11 years ago

nekopanic commented 12 years ago

We recommended the use of help() to students, but I found students with two problems:

  1. help(function_name) enters into a pager, and the content is a little too technical. Students need to press 'q' to exit the pager and return to the shell.
  2. help() enters a help cli within the interpreter. Then it gets really confusing as to when you are in the help cli and how to get out of it and return to the Python shell.

By contrast, I didn't find anybody having difficulties browsing the turtle API web documentation.

lehmannro commented 11 years ago

It seems all mentions of bare help() have been purged from the docs already. If you feel we should also provide help in case they run into it, please re-open this ticket.