Ticket #6840: trac_6840-notebook-documentation.patch

File trac_6840-notebook-documentation.patch, 12.8 KB (added by timdumol, 12 years ago)

Fixes docstrings added by patch #6568 in notebook.py and worksheet.py. Depends on #6568

  • sage/server/notebook/notebook.py

    # HG changeset patch
    # User Tim Dumol <tim@timdumol.com>
    # Date 1251530102 -28800
    # Node ID 0f044c1dab8985bf41ca31b83173b41d8b7732ae
    # Parent  832b4605800675c661715a511041de9ea77904a7
    * Fixed docstrings added by patch #6568 in `notebook.py` and `worksheet.py`
    
    diff -r 832b46058006 -r 0f044c1dab89 sage/server/notebook/notebook.py
    a b  
    284284
    285285    def create_user_with_same_password(self, user, other_user):
    286286        r"""
     287        Changes password of ``user`` to that of ``other_user``.
     288       
    287289        INPUT:
    288290       
    289291       
    290292        -  ``user`` - a string
    291293       
    292         -  ``other_user`` - a string
     294        -  ``other_user`` - a strin
    293295       
    294296       
    295         OUTPUT: Changes password of ``user`` to that of
    296         ``other_user``.
    297        
    298297        EXAMPLES::
    299298       
    300299            sage: nb = sage.server.notebook.notebook.Notebook(tmp_dir())
     
    315314
    316315    def user_is_admin(self, user):
    317316        """
     317        Returns true if ``user`` is an admin.
     318
     319        INPUT:
     320
     321        - user - instance of User
     322       
    318323        EXAMPLES::
    319324       
    320325            sage: nb = sage.server.notebook.notebook.Notebook(tmp_dir())
     
    329334
    330335    def user_is_guest(self, username):
    331336        """
     337        Returns true if ``username`` is a guest.
     338
     339        INPUT:
     340
     341        - username - String of the username
     342       
    332343        EXAMPLES::
    333344       
    334345            sage: nb = sage.server.notebook.notebook.Notebook(tmp_dir())
     
    393404        return [x for x in self.usernames() if not x in ['guest', '_sage_', 'pub']]
    394405
    395406    def default_user(self):
    396         """
     407        r"""
    397408        Return a default login name that the user will see when confronted
    398409        with the Sage notebook login page.
    399410       
    400         OUTPUT: string
    401        
    402         Currently this returns 'admin' if that is the *only* user.
    403         Otherwise it returns the string ".
     411        OUTPUT:
     412
     413        string -- the default username. Currently this returns 'admin'
     414        if that is the *only* user.  Otherwise it returns an empty string
     415        ('').
    404416       
    405417        EXAMPLES::
    406418       
     
    11701182        Outputs html containing the plain text version of a worksheet
    11711183
    11721184        INPUT:
     1185
     1186       
    11731187        - ``filename`` - filename of a worksheet
    11741188        - ``prompts``  - boolean
    11751189
    11761190        OUTPUT:
    1177         - A string containing the html for the plain text version
     1191       
     1192        - string -- containing the html for the plain text version
    11781193        """
    11791194        worksheet = self.get_worksheet_with_filename(filename)
    11801195        text = escape(worksheet.plain_text(prompts = prompts))
     
    13091324        return s
    13101325
    13111326    def worksheet_html(self, filename, do_print=False):
    1312         """
     1327        r"""
    13131328        Returns the HTML for the worksheet.
    13141329
    13151330        INPUT:
     1331
     1332       
    13161333        - ``username`` - a string
     1334       
    13171335        - ``worksheet`` - an instance of Worksheet
    13181336
    13191337        OUTPUT:
    1320         - a string containing the HTML
     1338       
     1339        - string -- the HTML for the worksheet
    13211340
    13221341        EXAMPLES::
    13231342       
     
    13591378    # Revision history for a worksheet
    13601379    ##########################################################
    13611380    def html_worksheet_revision_list(self, username, worksheet):
    1362         """
     1381        r"""
    13631382        Returns the HTML for the revision list of a worksheet.
    13641383
    13651384        INPUT:
     1385
     1386       
    13661387        - ``username`` - a string
     1388       
    13671389        - ``worksheet`` - an instance of Worksheet
    13681390
    13691391        OUTPUT:
    1370         - a string containing the HTML
     1392
     1393       
     1394        - string -- the HTML for the revision list
    13711395
    13721396        EXAMPLES::
    13731397       
     
    13891413
    13901414
    13911415    def html_specific_revision(self, username, ws, rev):
    1392         """
     1416        r"""
    13931417        Returns the HTML for a revision of the worksheet.
    13941418
    13951419        INPUT:
     1420
     1421       
    13961422        - ``username`` - a string
     1423       
    13971424        - ``ws`` - an instance of Worksheet
     1425       
    13981426        - ``rev`` - a string containing the key of the revision
    13991427
    14001428        OUTPUT:
    1401         - a string containing the HTML
     1429       
     1430        - string -- the HTML for the revision
    14021431        """
    14031432        t = time.time() - float(rev[:-4])
    14041433        time_ago = worksheet.convert_seconds_to_meaningful_time_span(t)
     
    14341463       
    14351464
    14361465    def html_share(self, worksheet, username):
    1437         """
     1466        r"""
    14381467        Returns the HTML for the share page of a worksheet.
    14391468
    14401469        INPUT:
     1470
     1471       
    14411472        - ``username`` - a string
     1473       
    14421474        - ``worksheet`` - an instance of Worksheet
    14431475
    14441476        OUTPUT:
    1445         - a string containing the HTML
     1477
     1478       
     1479        - string -- the HTML for the share page
    14461480       
    14471481        EXAMPLES::
    14481482       
     
    14661500
    14671501
    14681502    def html_download_or_delete_datafile(self, ws, username, filename):
    1469         """
     1503        r"""
    14701504        Returns the HTML for the download or delete datafile page.
    14711505
    14721506        INPUT:
     1507
     1508       
    14731509        - ``username`` - a string
     1510       
    14741511        - ``ws`` - an instance of Worksheet
     1512       
    14751513        - ``filename`` - the name of the file
    14761514
    14771515        OUTPUT:
    1478         - a string containing the HTML
     1516
     1517       
     1518        - string -- the HTML for the page
    14791519
    14801520        EXAMPLES::
    14811521       
     
    16131653    # HTML -- generate most html related to the whole notebook page
    16141654    ###########################################################
    16151655    def html_debug_window(self):
    1616         """
     1656        r"""
    16171657        Returns the HTML for the debug window
    16181658
    16191659        OUTPUT:
    1620         - the HTML for the debug window
     1660       
     1661        - string -- the HTML for the debug window
    16211662   
    16221663        EXAMPLES::
    16231664
    1624         sage: nb = sage.server.notebook.notebook.Notebook(tmp_dir())
    1625         sage: print(nb.html_debug_window())
    1626         <div class='debug_window'>
    1627             <div class='debug_output'><pre id='debug_output'></pre></div>
    1628             <textarea rows=5 id='debug_input' class='debug_input'
    1629                       onKeyPress='return debug_keypress(event);'
    1630                       onFocus='debug_focus();' onBlur='debug_blur();'></textarea>
    1631         </div>
     1665            sage: nb = sage.server.notebook.notebook.Notebook(tmp_dir())
     1666            sage: print(nb.html_debug_window())
     1667            '<div class='debug_window'>...</div>'
    16321668        """
    16331669        return template("notebook/debug_window.html")
    16341670
    16351671   
    16361672    def html_plain_text_window(self, worksheet, username):
    1637         """
     1673        r"""
    16381674        Returns a window that displays a plain text version of the
    16391675        worksheet
    16401676       
    16411677        INPUT:
     1678
     1679       
    16421680        -  ``worksheet`` - a worksheet
     1681       
    16431682        -  ``username`` - name of the user
    16441683
    16451684        OUTPUT:
    1646         - a window that displays a plain text version of the
    1647         worksheet
     1685
     1686       
     1687        - string -- html for a window that displays a plain text
     1688        version of the worksheet
    16481689       
    16491690        EXAMPLES::
    16501691       
     
    16691710        Return a window for editing ``worksheet``.
    16701711       
    16711712        INPUT:
     1713
     1714       
    16721715        - ``username`` - a string containing the username
     1716       
    16731717        - ``worksheet`` - a Worksheet instance
    16741718
    16751719        OUTPUT:
     1720       
    16761721        - html for a window for editing ``worksheet``.
    16771722
    16781723        EXAMPLES::
     
    16951740                        sage_jsmath_macros = sage_jsmath_macros)
    16961741   
    16971742    def html_beforepublish_window(self, worksheet, username):
    1698         """
     1743        r"""
    16991744        Return the html code for a page dedicated to worksheet publishing
    17001745        prior to the publication of the given worksheet.
    17011746       
    17021747        INPUT:
     1748
     1749       
    17031750        - ``worksheet`` - instance of Worksheet
     1751       
    17041752        - ``username`` - string
    17051753
    17061754        EXAMPLES::
     
    17281776                        sage_jsmath_macros = sage_jsmath_macros)
    17291777       
    17301778    def html_afterpublish_window(self, worksheet, username, url, dtime):
    1731         """
     1779        r"""
    17321780        Return the html code for a page dedicated to worksheet publishing
    17331781        after the publication of the given worksheet.
    17341782       
    17351783        INPUT:
     1784
     1785       
    17361786        - ``worksheet`` - instance of Worksheet
     1787       
    17371788        - ``username`` - string
     1789       
    17381790        - ``url`` - a string representing the url of the published worksheet
     1791       
    17391792        - ``dtime`` - instance of time.struct_time representing the publishing time
    17401793        """
    17411794        from time import strftime
     
    17501803                        sage_jsmath_macros = sage_jsmath_macros)
    17511804
    17521805    def html_upload_data_window(self, ws, username):
    1753         """
     1806        r"""
    17541807        Returns the html for the "Upload Data" window
    17551808
    17561809        INPUT:
     1810
     1811       
    17571812        - ``worksheet`` - instance of Worksheet
     1813       
    17581814        - ``username`` - string
    17591815
    17601816        EXAMPLES::
     
    17731829   
    17741830
    17751831    def html(self, worksheet_filename=None, username='guest', show_debug=False, admin=False):
    1776         """
     1832        r"""
    17771833        Returns the html for index page of a worksheet.
    17781834
    17791835        INPUT:
     1836
     1837       
    17801838        - ``worksheet_filename`` - a string
     1839       
    17811840        - ``username`` - a string
     1841
    17821842        - ``show_debug`` - a boolean
     1843       
    17831844        - ``admin`` - a boolean
    17841845
    17851846        EXAMPLES::
     
    18201881
    18211882
    18221883    def html_worksheet_settings(self, ws, username):
    1823         """
     1884        r"""
    18241885        Returns the html for the setings page of the worksheet.
    18251886       
    18261887        INPUT:
     1888       
    18271889        - ``ws`` - instance of Worksheet
     1890       
    18281891        - ``username`` - string
    18291892
    18301893        EXAMPLES::
     
    18561919        return s
    18571920
    18581921    def html_doc(self, username):
    1859         """
     1922        r"""
    18601923        Returns the html for the documentation pages.
    18611924       
    18621925        INPUT:
     1926       
    18631927        - ``worksheet_filename`` - a string
     1928       
    18641929        - ``username`` - a string
     1930       
    18651931        - ``show_debug`` - a boolean
     1932       
    18661933        - ``admin`` - a boolean
    18671934
    18681935        EXAMPLES::
  • sage/server/notebook/worksheet.py

    diff -r 832b46058006 -r 0f044c1dab89 sage/server/notebook/worksheet.py
    a b  
    12361236        OUTPUT:
    12371237       
    12381238       
    1239         -  ``string`` - a string of HTML as a bunch of table
     1239        -  ``string`` -- a string of HTML as a bunch of table
    12401240           rows.
    12411241       
    12421242       
     
    22122212    ##########################################################
    22132213    def html(self, include_title=True, do_print=False,
    22142214             confirm_before_leave=False, read_only=False):
    2215         """
    2216         INPUT:
     2215        r"""
     2216        INPUT:
     2217
     2218       
    22172219        - publish - a boolean stating whether the worksheet is published
     2220       
    22182221        - do_print - a boolean
    22192222
    22202223        OUTPUT:
    2221         - returns the html for the worksheet
     2224
     2225       
     2226        - string -- the html for the worksheet
    22222227       
    22232228        EXAMPLES::
    22242229       
     
    22752280    def html_save_discard_buttons(self):
    22762281        r"""
    22772282        OUTPUT:
    2278         - returns the html for the save, discard, etc. buttons
     2283       
     2284        - string -- the html for the save, discard, etc. buttons
    22792285
    22802286        EXAMPLES::
    22812287
     
    22892295    def html_share_publish_buttons(self, select=None, backwards=False):
    22902296        r"""
    22912297        INPUT:
     2298
     2299       
    22922300        - select - a boolean
     2301       
    22932302        - backwards - a boolean
    22942303
    22952304        OUTPUT:
    2296         - returns the html for the share, publish, etc. buttons
     2305
     2306       
     2307        - string -- the html for the share, publish, etc. buttons
    22972308
    22982309        EXAMPLES::
    22992310
     
    23102321# <option title="Configure this worksheet" value="worksheet_settings();">Worksheet settings</option>
    23112322
    23122323    def html_menu(self):
    2313         """
    2314         OUTPUT:
    2315         - returns the html for the menus of the worksheet
     2324        r"""
     2325        OUTPUT:
     2326       
     2327        - string -- the html for the menus of the worksheet
    23162328
    23172329        EXAMPLES::
    23182330       
     
    23302342                        doc_worksheet = self.is_doc_worksheet())
    23312343
    23322344    def html_worksheet_body(self, do_print, publish=False):
    2333         """
    2334         INPUT:
     2345        r"""
     2346        INPUT:
     2347
     2348       
    23352349        - publish - a boolean stating whether the worksheet is published
     2350       
    23362351        - do_print - a boolean
    23372352
    23382353        OUTPUT:
    2339         - returns the html for the File menu of the worksheet
     2354
     2355       
     2356        - string -- the html for the File menu of the worksheet
    23402357
    23412358        EXAMPLES::
    23422359       
     
    40204037def format_completions_as_html(cell_id, completions):
    40214038    """
    40224039    INPUT:
     4040
     4041   
    40234042    - cell_id - id for the cell of the completions
     4043   
    40244044    - completions - list of completions in row-major order
    40254045   
    40264046    OUTPUT:
    4027     - html for the completions formatted in rows and columns
     4047
     4048   
     4049    - string -- html for the completions formatted in rows and columns
    40284050    """
    40294051    if len(completions) == 0:
    40304052        return ''