#17280: Notebook commandline argparse
-------------------------------------+-------------------------------------
Reporter: vbraun | Owner:
Type: defect | Status: needs_review
Priority: blocker | Milestone: sage-6.4
Component: scripts | Resolution:
Keywords: | Merged in:
Authors: Volker Braun | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/vbraun/notebook_commandline_argparse|
ce9db90e99881ed20cda5a3a3d490365b912b7b2
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by kcrisman):
From sage-release, a suggestion to get this finalized:
----
> - whether the option --notebook-dir is documented in ./sage -h (or
--advanced);
> IMHO it should be
It is not, and that points us to
{{{
$ ./sage --notebook --help
usage: sage-notebook [-h] [--log LOG] [--notebook [NOTEBOOK]]
The Sage notebook launcher is used to start the notebook, and allows you
to
choose between different implementations. Any further command line options
are
passed to the respective notebook.
optional arguments:
-h, --help show this help message and exit. Can be combined
with
"--notebook=[...]" to see notebook-specific
options
--log LOG one of [DEBUG, INFO, ERROR, WARNING, CRITICAL]
--notebook [NOTEBOOK], -n [NOTEBOOK], -notebook [NOTEBOOK]
The notebook to run [one of: default, ipython,
sagenb]. Default is sagenb
}}}
which also doesn't help, while that points us to
{{{
$ ./sage --notebook=sagenb --help
}}}
which unfortunately just gives the notebook? commands but doesn't tell how
to use them with the notebook-specific options.
> - on whether the old behaviour "-n directory=sage.sagenb" is documented
> somewhere and whether this documentation has been adapted to the new
> situation.
It was documented in the following way, in `sage --advanced`
{{{
-n, -notebook [...] -- start the Sage notebook (options are the same
as for the notebook command in Sage)
}}}
So I would say that since I ''do'' agree that anyone using this option
probably is savvy enough to actually read the help, perhaps documenting
exactly how the options are to be called in `sage --advanced` and/or `sage
--notebook --help` would be enough to resolve this issue. (Changing
`sage --notebook=sagenb --help` would require more annoyance than worth.)
This should be pretty easy to do in the script itself, and given that we
never said exactly how to *call* the options before I think that as long
as we clearly document this (not necessarily with zillions of examples,
but maybe two) then this would work okay.
One could at the same time add the info about the default directory,
incidentally.
--
Ticket URL: <http://trac.sagemath.org/ticket/17280#comment:13>
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 unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
