Changes between Version 5 and Version 8 of Ticket #11817


Ignore:
Timestamp:
09/06/15 15:19:17 (4 years ago)
Author:
chapoton
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #11817

    • Property Status changed from positive_review to closed
    • Property Resolution changed from to fixed
    • Property Merged in changed from to sage-5.1.beta1
  • Ticket #11817 – Description

    v5 v8  
    99'\n    Format Sage documentation ``s`` for viewing with IPython.\n\n    This calls ``detex`` on ``s`` to convert LaTeX commands to plain\n    text, and if ``s`` contains a string of the form "<<<obj>>>",\n    then it replaces it with the docstring for "obj".\n\n    INPUT:\n\n    - ``s`` - string\n    - ``embedded`` - boolean (optional, default False)\n\n    OUTPUT: string\n\n    Set ``embedded`` equal to True if formatting for use in the\n    notebook; this just gets passed as an argument to ``detex``.\n\n    EXAMPLES::\n\n        sage: from sage.misc.sagedoc import format\n        sage: identity_matrix(2).rook_vector.__doc__[115:184]\n        \'Let `A` be a general `m` by `n`\\n        (0,1)-matrix with `m \\\\le n`. \'\n        sage: format(identity_matrix(2).rook_vector.__doc__[115:184])\n        \'Let A be a general m by n\\n   (0,1)-matrix with m <= n.\\n\'\n\n    If the first line of the string is \'nodetex\', remove \'nodetex\' but\n    don\'t modify any TeX commands::\n    \n        sage: format("nodetex\\n`x \\\\geq y`")\n        \'\\n`x \\\\geq y`\'\n\n    Testing a string enclosed in triple angle brackets::\n\n        sage: format(\'<<<identity_matrix\')\n        \'<<<identity_matrix\\n\'\n        sage: format(\'identity_matrix>>>\')\n        \'identity_matrix>>>\\n\'\n        sage: format(\'<<<identity_matrix>>>\')[:28]\n        \'Definition: identity_matrix(\'\n    '
    1010sage: format?
    11 Type:           function
    12 Base Class:     <type 'function'>
    13 String Form:    <function format at 0xcc8a28>
    14 Namespace:      Interactive
    15 File:           /mnt/local/king/SAGE/broken/local/lib/python2.6/site-packages/sage/misc/sagedoc.py
    16 Definition:     format(s, embedded=False)
     11Type:function
     12Base Class:<type 'function'>
     13String Form:<function format at 0xcc8a28>
     14Namespace:Interactive
     15File:/mnt/local/king/SAGE/broken/local/lib/python2.6/site-packages/sage/misc/sagedoc.py
     16Definition:format(s, embedded=False)
    1717Docstring:
    1818    <no docstring>