#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):

 > > which unfortunately just gives the notebook? commands but doesn't tell
 how to use them with the notebook-specific options.
 >
 > Which part of "Any further command line options are passed to the
 respective notebook" is unclear?

 Because user X will know to read help, but may NOT understand the arcane
 syntax for doing so!  Namely, I would think this continues to allow
 {{{
 sage --notebook foo=bar
 }}}
 because I had never even heard of the `sage --notebook -- foo=bar` syntax.
 Yes, I'm stupid and uneducated.  Well, so will many users be.  Especially
 since I was wrong - I said
 > It was documented in the following way,
 but it still ''is'' documented this way.

 > If you want to add to the online-help then just post a commit. IMHO it
 is clear and concise. There is always a tradeoff between longer and buried
 in a text wall.
 Yes, of course.  Though Let me see if I can cook something up; my concern
 is that I will make a stupid mistake, while you speak this syntax
 natively, as it were.  For instance, is this a way to spice this up
 ''correctly''?
 {{{
 usage: sage-notebook [-h] [--log LOG] [--notebook [NOTEBOOK]]
 [--option=foo ...]

 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}}}
    --option=foo       Additional options to be sent to the notebook can
                                be added using this syntax
 }}}

--
Ticket URL: <http://trac.sagemath.org/ticket/17280#comment:15>
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.

Reply via email to