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

help() should give Sage help, not Python #3091

Closed
sagetrac-gnprice mannequin opened this issue May 3, 2008 · 4 comments
Closed

help() should give Sage help, not Python #3091

sagetrac-gnprice mannequin opened this issue May 3, 2008 · 4 comments

Comments

@sagetrac-gnprice
Copy link
Mannequin

sagetrac-gnprice mannequin commented May 3, 2008

When I fired up Sage having never used it before, the first thing I tried after '1+1' and 'f(x) = x + x' followed by 'f(2)' was 'help'. I was disappointed to see that it gave the Python help system. I know Python, and I suspect even most Sage users who don't are more likely to want Sage help than Python help when they start out.

sage: help
Type help() for interactive help, or help(object) for help about object.
sage: help()

Welcome to Python 2.5!  This is the online help utility.

If this is your first time using Python, you should definitely check out
the tutorial on the Internet at http://www.python.org/doc/tut/.

Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules.  To quit this help utility and
return to the interpreter, just type "quit".

To get a list of available modules, keywords, or topics, type "modules",
"keywords", or "topics".  Each module also comes with a one-line summary
of what it does; to list the modules whose summaries contain a given word
such as "spam", type "modules spam".

help> 

I wound up using 'locals()' to see what was around -- a Python trick -- then 'help' on individual values that looked interesting. I still don't know how to find introductory, overview help on Sage from the interactive prompt, or a list of functions without using tricks from a Python background. I'm sure there's documentation on the web, but it's nice to be able to get to it while at the prompt.

Of course the native Python 'help' function is invaluable for printing and paging through docstrings, once one knows the name of something. I'm referring to its behavior with no arguments -- it should begin to give a clue about syntax, what's available, and where to look on the web, for Sage rather than for Python.

Thanks!

CC: @jhpalmieri

Component: user interface

Work Issues: Close as fixed

Issue created by migration from https://trac.sagemath.org/ticket/3091

@sagetrac-mabshoff sagetrac-mabshoff mannequin added this to the sage-3.0.2 milestone May 3, 2008
@sagetrac-gnprice
Copy link
Mannequin Author

sagetrac-gnprice mannequin commented May 7, 2008

comment:2

I just watched another first-time Sage user try typing 'help()' at the prompt. =)

Greg

@qed777
Copy link
Mannequin

qed777 mannequin commented Nov 14, 2009

Work Issues: Close as fixed

@qed777
Copy link
Mannequin

qed777 mannequin commented Nov 14, 2009

comment:3

I think we can close this ticket.

@qed777
Copy link
Mannequin

qed777 mannequin commented Jan 16, 2010

comment:4

With #6820 merged, should we close this ticket?

@qed777 qed777 mannequin changed the title help() should give Sage help, not Python [PLEASE CLOSE] help() should give Sage help, not Python Jan 16, 2010
@qed777 qed777 mannequin added the s: needs info label Jan 16, 2010
@jhpalmieri jhpalmieri removed this from the sage-4.3.1 milestone Jan 16, 2010
@sagetrac-mvngu sagetrac-mvngu mannequin changed the title [PLEASE CLOSE] help() should give Sage help, not Python help() should give Sage help, not Python Jan 17, 2010
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