#12421: make it so the prompt at the end of a docstring on the Sage command
line is
more newbie friendly
-----------------------------+----------------------------------------------
Reporter: was | Owner: mvngu
Type: enhancement | Status: new
Priority: minor | Milestone: sage-5.0
Component: documentation | Keywords:
Work_issues: | Upstream: N/A
Reviewer: | Author:
Merged: | Dependencies:
-----------------------------+----------------------------------------------
Comment(by was):
Replying to [comment:7 jhpalmieri]:
> I think only defining LESS if it isn't set makes the most sense. We
should also add information about this in the tutorial. I also wonder the
Sage banner should be changed or expanded: it currently says
> {{{
> ----------------------------------------------------------------------
> | Sage Version 5.0.beta1, Release Date: 2012-01-22 |
> | Type notebook() for the GUI, and license() for information. |
> ----------------------------------------------------------------------
> }}}
> `license()` is obviously important, but it's not something that people
will need to run very much,
> and it's not much help for newbies.
+1 -- I would be happy to get rid of that.
> We could eliminate its mention in the banner, or we could say
> {{{
> ----------------------------------------------------------------------
> | Sage Version 5.0.beta1, Release Date: 2012-01-22 |
> | Type 'notebook()' for the GUI and 'license()' for licensing. |
> | Type 'tutorial()' for a tutorial and 'help()' for more help. |
> ----------------------------------------------------------------------
> }}}
> The message printed by `help()` could also say something about what to
do after you type something like `matrix_plot?`.
In class yesterday some students strongly suggested that having a big
mention of a useful help command would be well worth doing. The first
thing help() mentions is the tutorial command, so we would not need to
explicitly mention tutorial.
While we're on the topic, another student complaint is that the notebook
server doesn't tell the user to type control-c to exit it, which is very
confusing and dangerous.
By the way, the tutorial() command has no doctest:
{{{
def tutorial(self):
"""
The Sage tutorial. To get started with Sage, start here.
"""
self._open("tutorial")
}}}
I think it could be tested by at least making sure that this isn't going
to happen (which is what I got on my laptop, since I was building sage-5.0
on 10.7 and the html docs I guess didn't build, since I had to restart
things):
{{{
...
OSError: The document 'tutorial' does not exist. Please build it.
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/12421#comment:8>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
