trac_6840-reviewer.patch on Ticket #6840 – Attachment – Sage

sage/server/introspect.py

# HG changeset patch
# User Minh Van Nguyen <nguyenminh2@gmail.com>
# Date 1251778289 25200
# Node ID 5b9a551e7b637aa7620d040fd6ef2e3f5f442abe
# Parent  05a268f0db84d9aaf69843a2356856e463ade619
trac 6840: reviewer patch; typo fixes

diff -r 05a268f0db84 -r 5b9a551e7b63 sage/server/introspect.py

-                      a
 """
 Sage Notebook Introspection
-"""
-"""
 TODO: - add support for grabbing source code from Pyrex functions
 (even if not perfect is better than nothing). - PNG or MathML
 output format for docstring

sage/server/misc.py

diff -r 05a268f0db84 -r 5b9a551e7b63 sage/server/misc.py

-                      a
 import socket
 def find_next_available_port(start, max_tries=100, verbose=False):
     """
     Find for the next available port, that is, a port for which a
+    Find the next available port, that is, a port for which a
     current connection attempt returns a 'Connection refused' error
     message.  If no port is found, raise a RuntimError exception.
     INPUT:
        - ``start`` - an int; the starting port number for the scan
+    - ``start`` - an int; the starting port number for the scan
        - ``max_tries`` - an int (default: 100); how many ports to scan
+    - ``max_tries`` - an int (default: 100); how many ports to scan
        - ``verbose`` - a bool (default: True); whether to print information
          about the scan
+    - ``verbose`` - a bool (default: True); whether to print information
+      about the scan
     OUTPUT:

sage/server/notebook/cell.py

diff -r 05a268f0db84 -r 5b9a551e7b63 sage/server/notebook/cell.py

-                      a
     def id(self):
         """
         Returns self's id.
+        Returns self's ID.
         OUTPUT:
         - int -- self's id.
+        - int -- self's ID.
         EXAMPLES::
 …
     def is_auto_cell(self):
         """
         Returns true if self is automatically evaluated.
+        Returns True if self is automatically evaluated.
         EXAMPLES::
 …
     def __cmp__(self, right):
         """
         Compares cells by `id`.
+        Compares cells by ID.
         EXAMPLES::
 …
     def __cmp__(self, right):
         """
         Compares cells by their `id`s.
+        Compares cells by their IDs.
         EXAMPLES::
 …
     def is_interacting(self):
         r"""
         Returns True if this cell is currently interacting with the user.
         EXAMPLES::
 …
             sage: C = W.new_cell_after(0, "@interact\ndef f(a=slider(0,10,1,5):\n    print a^2")
             sage: C.is_interacting()
             False
         """
         return hasattr(self, 'interact')
 …
         """
         Stops interaction with user.
+        TODO: Add doctests for :meth:`stop_interacting`.
+        TODO: Add doctests for :meth:`stop_interacting`.
         """
         if self.is_interacting():
             del self.interact
 …
     def process_cell_urls(self, urls):
         """
         Processes urls of the form 'cell://.*?' by replacing the
+        Processes URLs of the form ``'cell://.*?'`` by replacing the
         protocol with the path to self and appending self's version
         number.
 …
         INPUT:
             - ``ncols`` -- maximum number of columns
+        - ``ncols`` -- maximum number of columns
             - ``html`` -- boolean stating whether to output html
+        - ``html`` -- boolean stating whether to output HTML
             - ``raw`` -- boolean stating whether to output raw text
                         (takes precedence over html)
+        - ``raw`` -- boolean stating whether to output raw text
+          (takes precedence over HTML)
             - ``allow_interact`` -- boolean stating whether to allow interaction
+        - ``allow_interact`` -- boolean stating whether to allow interaction
         EXAMPLES::
 …
         Parse HTML for output.
         INPUT:
+            - ``s`` -- the input string containing HTML
+        - ``s`` -- the input string containing HTML
+            - ``ncols`` -- maximum number of columns
+        - ``ncols`` -- maximum number of columns
         EXAMPLES::
 …
     def introspect_html(self):
         """
         Returns html for introspection.
+        Returns HTML for introspection.
         EXAMPLES::
 …
     def html(self, wrap=None, div_wrap=True, do_print=False):
         r"""
         Returns the html for self.
+        Returns the HTML for self.
         INPUT:
         - ``wrap`` - a boolean stating whether to wrap lines. Defaults to
           configuration if not given,
+          configuration if not given.
         - ``div_wrap`` - a boolean stating whether to wrap ``div``.
 …
     def files_html(self, out):
         """
         Returns html to display the files in self's directory.
+        Returns HTML to display the files in self's directory.
         INPUT:
         - ``out`` - string to exclude files.
                     Format: To exclude bar, foo, ...`'cell://bar cell://foo ...'`
+          Format: To exclude bar, foo, ... ``'cell://bar cell://foo ...'``
         EXAMPLES::
 …
     def html_out(self, ncols=0, do_print=False):
         r"""
         Returns the html for self's output.
+        Returns the HTML for self's output.
         INPUT:
             - ``do_print`` -- a boolean stating whether to output html
                              for print
+        - ``do_print`` -- a boolean stating whether to output HTML
+          for print
             - ``ncols`` -- the number of columns
+        - ``ncols`` -- the number of columns
         EXAMPLES::

sage/server/notebook/docHTMLProcessor.py

diff -r 05a268f0db84 -r 5b9a551e7b63 sage/server/notebook/docHTMLProcessor.py

-                      a
 Live Documentation in the Notebook
 Processes Sage documentation into notebook worksheet format with
 evaluatable examples.
+evaluable examples.
 This takes in any HTML document, i.e., Sage documentation, and returns
 it in the editable format (like the notebook edit window). It also
 …
 Author:
     - Dorian Raymer (2006): first version
+- Dorian Raymer (2006): first version
     - William Stein (2007-06-10): rewrite to work with twisted Sage notebook
+- William Stein (2007-06-10): rewrite to work with twisted Sage notebook
     - Mike Hansen (2008-09-27): Rewrite to work with Sphinx HTML documentation
+- Mike Hansen (2008-09-27): Rewrite to work with Sphinx HTML documentation
 """
 #############################################################################
 #       Copyright (C) 2007 William Stein <wstein@gmail.com> and Dorian Raimer
 …
         All divs with CSS class="highlight" contain code examples.
         They include
          - Models of how the function works.  These begin with, e.g.,
            'INPUT:' and are re-styled as divs with
            class="usage_model".
+        - Models of how the function works.  These begin with, e.g.,
+          'INPUT:' and are re-styled as divs with
+          class="usage_model".
          - Actual Sage input and ouput.  These begin with 'sage:'.
            The input and output are separated according to the
            Notebook edit format.
+        - Actual Sage input and output.  These begin with 'sage:'.
+          The input and output are separated according to the
+          Notebook edit format.
         INPUT:

sage/server/notebook/interact.py

diff -r 05a268f0db84 -r 5b9a551e7b63 sage/server/notebook/interact.py

-                      a
 AUTHORS:
     - William Stein (2008-03-02): version 1.0 at Sage/Enthought Days
 in Texas
+- William Stein (2008-03-02): version 1.0 at Sage/Enthought Days
+in Texas
     - Jason Grout (2008-03): discussion and first few prototypes
+- Jason Grout (2008-03): discussion and first few prototypes
     - Jason Grout (2008-05): :class:`input_grid` control
+- Jason Grout (2008-05): :class:`input_grid` control
 """
 """
 …
    [ ] make option for text input that correctly gives something of
        the same type as the default input.
    [ ] matrix input control (method of matrix space) -- a spreadsheet like thing
    [ ] a 2d slider:
           u = ((xmin,xmax),(ymin,ymax))  2d slider   -- NOT IMPLEMENTED
    [ ] locator in a 2d graphic
+   [ ] a 2-D slider:
+          u = ((xmin,xmax),(ymin,ymax))  2-D slider   -- NOT IMPLEMENTED
+   [ ] locator in a 2-D graphic
    [ ] tab_view -- represents an object in which clicking the tab
                    with label lbl[i] displays expr[i]
    [ ] controls: make them easy to customize as below --
 …
     INPUT:
     - ``id`` - a string; the DOM id of the slider (better be unique)
+    - ``id`` - a string; the DOM ID of the slider (better be unique)
     - ``values`` - a string; 'null' or JavaScript string containing
       array of values on slider
 …
       the slider is done moving
     - ``steps`` - an integer; number of steps from minimum to maximum
       value.
+      value
     - ``default`` - an integer (default: 0); the default position of
       the slider
 …
     INPUT:
     - ``id`` - a string; the DOM id of the slider (better be unique)
+    - ``id`` - a string; the DOM ID of the slider (better be unique)
     - ``values`` - a string; 'null' or JavaScript string containing
       array of values on slider
 …
       the slider is done moving
     - ``steps`` - an integer; number of steps from minimum to maximum
       value.
+      value
     - ``default_l`` - an integer (default: 0); the default position of
       the left edge of the slider
 …
     INPUT:
     - ``id`` - an integer; the id of the HTML div element that this
       selector should have
+    - ``id`` - an integer; the ID of the HTML div element that this
+      selector should have.
     - ``change`` - a string; JavaScript code to execute when the color
       selector changes.
     - ``default`` - a string (default: ``'000000'``); default color as
       a 6-character HTML hex string.
+      a 6-character HTML hexadecimal string.
     OUTPUT:
 …
         - ``globs`` - a string:object dictionary; the globals
           interpreter variables, e.g., :func:`globals`, which is
           useful for evaling value.
+          useful for evaluating value.
         OUTPUT:
 …
     def cell_id(self):
         """
         Return the id of the cell that contains this :func:`interact` control.
+        Return the ID of the cell that contains this :func:`interact` control.
         OUTPUT:
         - an integer - id of cell that this control interacts
+        - an integer - ID of cell that this control interacts
         EXAMPLES:
         The output below should equal the id of the current cell::
+        The output below should equal the ID of the current cell::
             sage: sage.server.notebook.interact.InteractControl('theta', 1).cell_id()
 …
     def value_js(self, n):
         """
         Return JavaScript that evaluates to value of this control.
         If ``n`` is 0 return code for evaluation by the actual color
+        If ``n`` is 0, return code for evaluation by the actual color
         control.  If ``n`` is 1, return code for the text area that
         displays the current color.
 …
         - ``controls`` - a list of :class:`InteractControl` instances.
         - ``id`` - an integer; the id of the cell that contains this
+        - ``id`` - an integer; the ID of the cell that contains this
           InteractCanvas.
         - ``options`` - any additional keyword arguments (for example,
 …
     def cell_id(self):
         r"""
         Returns the cell id associated to this :class:`InteractCanvas`.
+        Returns the cell ID associated to this :class:`InteractCanvas`.
         OUTPUT:
 …
         - list of controls
+        .. note:: Returns a reference to a mutable list.
+        .. note::
+            Returns a reference to a mutable list.
         EXAMPLES::
 …
         INPUT:
         - ``cell_id`` - an integer; the ambient cell's id
+        - ``cell_id`` - an integer; the ambient cell's ID
         EXAMPLES::
 …
     (see defaults below).
         * ``u = input_box(default=None, label=None, type=None)`` -
           input box with given ``default``; use ``type=str`` to get
           input as an arbitrary string
+    * ``u = input_box(default=None, label=None, type=None)`` -
+      input box with given ``default``; use ``type=str`` to get
+      input as an arbitrary string
         * ``u = slider(vmin, vmax=None, step_size=1, default=None,
           label=None)`` - slider with given list of possible values;
           ``vmin`` can be a list
+    * ``u = slider(vmin, vmax=None, step_size=1, default=None,
+      label=None)`` - slider with given list of possible values;
+      ``vmin`` can be a list
         * ``u = range_slider(vmin, vmax=None, step_size=1,
           default=None, label=None)`` - range slider with given list
           of possible values; ``vmin`` can be a list
+    * ``u = range_slider(vmin, vmax=None, step_size=1,
+      default=None, label=None)`` - range slider with given list
+      of possible values; ``vmin`` can be a list
         * ``u = checkbox(default=True, label=None)`` - a checkbox
+    * ``u = checkbox(default=True, label=None)`` - a checkbox
         * ``u = selector(values, label=None, nrows=None, ncols=None,
           buttons=False)`` - a dropdown menu or buttons (get buttons
           if ``nrows``, ``ncols``, or ``buttons`` is set, otherwise a
           dropdown menu)
+    * ``u = selector(values, label=None, nrows=None, ncols=None,
+      buttons=False)`` - a dropdown menu or buttons (get buttons
+      if ``nrows``, ``ncols``, or ``buttons`` is set, otherwise a
+      dropdown menu)
         * ``u = input_grid(nrows, ncols, default=None, label=None,
           to_value=lambda x:x, width=4)`` - an editable grid of
           objects (a matrix or array)
+    * ``u = input_grid(nrows, ncols, default=None, label=None,
+      to_value=lambda x:x, width=4)`` - an editable grid of
+      objects (a matrix or array)
         * ``u = text_control(value='')`` - a block of text
+    * ``u = text_control(value='')`` - a block of text
     You can create a color selector by setting the default value for a
 …
     your function.  These are all just convenient shortcuts for
     creating the controls listed above.
         * ``u`` - blank input_box field
+    * ``u`` - blank input_box field
         * ``u = element`` - input_box with ``default=element``, if
           element not below.
+    * ``u = element`` - input_box with ``default=element``, if
+      element not below.
         * ``u = (umin,umax)`` - continuous slider (really `100` steps)
+    * ``u = (umin,umax)`` - continuous slider (really `100` steps)
         * ``u = (umin,umax,du)`` - slider with step size ``du``
+    * ``u = (umin,umax,du)`` - slider with step size ``du``
         * ``u = list`` - buttons if ``len(list)`` at most `5`;
           otherwise, drop down
+    * ``u = list`` - buttons if ``len(list)`` at most `5`;
+      otherwise, drop down
         * ``u = generator`` - a slider (up to `10000` steps)
+    * ``u = generator`` - a slider (up to `10000` steps)
         * ``u = bool`` - a checkbox
+    * ``u = bool`` - a checkbox
         * ``u = Color('blue')`` - a 2D RGB color selector; returns
           ``Color`` object
+    * ``u = Color('blue')`` - a 2-D RGB color selector; returns
+      ``Color`` object
         * ``u = (default, v)`` - ``v`` as above, with given
           ``default`` value
+    * ``u = (default, v)`` - ``v`` as above, with given
+      ``default`` value
         * ``u = (label, v)`` - ``v`` as above, with given ``label``
           (a string)
+    * ``u = (label, v)`` - ``v`` as above, with given ``label``
+      (a string)
         * ``u = matrix`` - an ``input_grid`` with ``to_value`` set to
           ``matrix.parent()`` and default values given by the matrix
+    * ``u = matrix`` - an ``input_grid`` with ``to_value`` set to
+      ``matrix.parent()`` and default values given by the matrix
     .. note::
         Suppose you would like to make a interactive with a default
+        Suppose you would like to make an interactive with a default
         RGB color of ``(1,0,0)``, so the function would have signature
         ``f(color=(1,0,0))``.  Unfortunately, the above shortcuts
         reinterpret the ``(1,0,0)`` as a discrete slider with step
 …
         ...       show(L)
         <html>...
     You can rotate and zoom into 3D graphics while interacting with a
+    You can rotate and zoom into 3-D graphics while interacting with a
     variable::
         sage: @interact
 …
         ...     show(G, figsize=5, xmin=0, ymin=0)
         <html>...
     Two "sinks" displayed simultaneously via a contour plot and a 3D
+    Two "sinks" displayed simultaneously via a contour plot and a 3-D
     interactive plot::
         sage: @interact
 …
         - ``display_value`` - a bool, whether to display the current
           value to the right of the slider
         EXAMPLES::
+        EXAMPLES:
         We specify both ``vmin`` and ``vmax``.  We make the default
         `3`, but since `3` isn't one of `3/17`-th spaced values
 …
         - ``display_value`` - a bool, whether to display the current
           value below the slider
         EXAMPLES::
+        EXAMPLES:
         We specify both ``vmin`` and ``vmax``.  We make the default
         `(3,4)` but since neither is one of `3/17`-th spaced
 …
     INPUT:
     - ``cell_id`` - an integer; the id of an :func:`interact` cell
+    - ``cell_id`` - an integer; the ID of an :func:`interact` cell
     - ``var`` - an object; a variable associated to that cell

sage/server/notebook/notebook.py

diff -r 05a268f0db84 -r 5b9a551e7b63 sage/server/notebook/notebook.py

-                      a
         """
         try:
             dir = self.__absdir
         except AttributeErrro:
+        except AttributeError:
             dir = self.__dir
         import shutil
         # We ignore_errors because in rare parallel doctesting
 …
     def user_is_admin(self, user):
         """
         Return true if ``user`` is an admin.
+        Return True if ``user`` is an admin.
         INPUT:
 …
     def user_is_guest(self, username):
         """
         Return true if ``username`` is a guest.
+        Return True if ``username`` is a guest.
         INPUT:
 …
         - a list of strings.
+        EXAMPLES: We make a new notebook with two users and two worksheets,
+        EXAMPLES:
+        We make a new notebook with two users and two worksheets,
         then list their names::
             sage: nb = sage.server.notebook.notebook.Notebook(tmp_dir())
 …
         -  ``worksheet`` - a newly created Worksheet instance
+        EXAMPLES: We create a notebook and import a plain text worksheet
+        EXAMPLES:
+        We create a notebook and import a plain text worksheet
         into it.
         ::
 …
         -  a new instance of Worksheet
+        EXAMPLES: We write a plain text worksheet to a file and import it
+        EXAMPLES:
+        We write a plain text worksheet to a file and import it
         using this function.
         ::

sage/server/notebook/template.py

diff -r 05a268f0db84 -r 5b9a551e7b63 sage/server/notebook/template.py

-                      a
 AUTHORS:
     - Bobby Moretti (2007-07-18): initial version
+- Bobby Moretti (2007-07-18): initial version
+    - Timothy Clemans and Mike Hansen (2008-10-27): major update
+- Timothy Clemans and Mike Hansen (2008-10-27): major update
 """
 #############################################################################
 #       Copyright (C) 2007 William Stein <wstein@gmail.com>
 …
     INPUT:
     - ``filename`` - a string; the filename of the template relative
       to $SAGE_ROOT/devel/sage/sage/server/notebook/templates
+      to ``SAGE_ROOT/devel/sage/sage/server/notebook/templates``
     - ``user_context`` - a dictionary; the context in which to evaluate
       the file's template variables

sage/server/notebook/worksheet.py

diff -r 05a268f0db84 -r 5b9a551e7b63 sage/server/notebook/worksheet.py

-                      a
 worksheet, spawning Sage processes that do all of the actual work
 and are controlled via pexpect, and reporting on results of
 calculations. The state of the cells in a worksheet is stored on
 the filesystem (not in the notebook pickle sobj).
+the file system (not in the notebook pickle sobj).
 AUTHORS:
 …
         -  ``-1,0,1`` - comparison is on the underlying
            filenames.
+           file names.
         EXAMPLES::
 …
     def attached_data_files(self):
         """
         Return a list of the filenames of files in the worksheet data
+        Return a list of the file names of files in the worksheet data
         directory.
         OUTPUT: list of strings
 …
         INPUT:
         -  ``sysem`` - string (default: 'sage')
+        -  ``system`` - string (default: 'sage')
         EXAMPLES::
 …
            The reason the input is a string and lower case instead of
            a Python bool is because this gets called indirectly from
            javascript. (And, Jason Grout wrote this and didn't realize
+           JavaScript. (And, Jason Grout wrote this and didn't realize
            how unpythonic this design is - it should be redone to use
            True/False.)
 …
         -  ``comment`` - string
         -  ``usename`` - string
+        -  ``username`` - string
         EXAMPLES: We create a worksheet and rate it, then look at the
 …
     def rating(self):
         """
         Return overall aerage rating of self.
+        Return overall average rating of self.
         OUTPUT: float or the int -1 to mean "not rated"
 …
     def limit_snapshots(self):
         r"""
         This routine will limit the number of snapshots of a worksheet,
         as specified by a hard-cioded value below.
+        as specified by a hard-coded value below.
         Prior behavior was to allow unlimited numbers of snapshots and
         so this routine will not delete files created prior to this change.
 …
         -  ``text`` - a string
         -  ``ignore_ids`` - bool (default: False); if True
            ignore all the id's in the {{{}}} code block.
+           ignore all the IDs in the {{{}}} code block.
         EXAMPLES: We create a new test notebook and a worksheet.
 …
              confirm_before_leave=False, read_only=False):
         r"""
         INPUT:
         - publish - a boolean stating whether the worksheet is published
         - do_print - a boolean
         OUTPUT:
+        - string -- the html for the worksheet
+        - string -- the HTML for the worksheet
         EXAMPLES::
 …
         r"""
         OUTPUT:
         - string -- the html for the save, discard, etc. buttons
+        - string -- the HTML for the save, discard, etc. buttons
         EXAMPLES::
 …
     def html_share_publish_buttons(self, select=None, backwards=False):
         r"""
         INPUT:
         - select - a boolean
         - backwards - a boolean
         OUTPUT:
+        - string -- the html for the share, publish, etc. buttons
+        - string -- the HTML for the share, publish, etc. buttons
         EXAMPLES::
 …
         r"""
         OUTPUT:
         - string -- the html for the menus of the worksheet
+        - string -- the HTML for the menus of the worksheet
         EXAMPLES::
 …
     def html_worksheet_body(self, do_print, publish=False):
         r"""
         INPUT:
         - publish - a boolean stating whether the worksheet is published
         - do_print - a boolean
         OUTPUT:
+        - string -- the html for the File menu of the worksheet
+        - string -- the HTML for the File menu of the worksheet
         EXAMPLES::
 …
         INPUT:
         -  ``username`` - user who would like to edit this
            file.
 …
         -  ``C`` - a Cell
         -  ``username`` - the name of the user that is
            evaluating this cell (mainly used for loging)
+           evaluating this cell (mainly used for login)
         .. note::

sage/server/support.py

diff -r 05a268f0db84 -r 5b9a551e7b63 sage/server/support.py

-                      a
 def source_code(s, globs, system='sage'):
     r"""
     Format an object's source code to process and display in the the
+    Format an object's source code to process and display in the
     Sage notebook.
     INPUT:

Context Navigation

Ticket #6840: trac_6840-reviewer.patch

sage/server/introspect.py

sage/server/misc.py

sage/server/notebook/cell.py

sage/server/notebook/docHTMLProcessor.py

sage/server/notebook/interact.py

sage/server/notebook/notebook.py

sage/server/notebook/template.py

sage/server/notebook/worksheet.py

sage/server/support.py

Download in other formats: