Sage Developer's Guide - Mirrors

More documents

Recommendations

Info

Sage Developer’s Guide, Release 6.1.1follow Python conventions by using spaces only.• A WARNING block for critical information about your code. For example, the WARNING block might includeinformation about when or under which conditions your code might break, or information that the user shouldbe particularly aware of. A WARNING block should start with .. WARNING::. It can also be the lower-caseform .. warning::. However, you are encouraged to use the upper-case form .. WARNING::. Here’san example of a WARNING block:.. WARNING::Whenever you edit the Sage documentation, make sure thatthe edited version still builds. That is, you need to ensurethat you can still build the HTML and PDF versions of theupdated documentation. If the edited documentation fails tobuild, it is very likely that you would be requested tochange your patch.• A TODO block for room for improvements. The TODO block might contains disabled doctests to demonstratethe desired feature. A TODO block should start with .. TODO::. It can also be the lower-case form ..todo::. However, you are encouraged to use the upper-case form .. TODO::. Here’s an example of aTODO block:.. TODO::Improve further function ‘‘have_fresh_beers‘‘ using algorithm‘‘buy_a_better_fridge‘‘::sage: have_fresh_beers(’Bière de l\’Yvette’) # todo: not implementedEnjoy !• A REFERENCES block to list books or papers (optional). This block serves a similar purpose to a list of referencesin a research paper, or a bibliography in a monograph. If your method, function or class uses an algorithmthat can be found in a standard reference, you should list that reference under this block. The Sphinx/ReSTmarkup for citations is described at http://sphinx.pocoo.org/rest.html#citations. See below for an example. Sagealso add specific markup for links to sage trac tickets and Wikipedia. See Hyperlinks. Here’s an example of aREFERENCES block:This docstring is referencing [SC]_. Just remember that referencesare global, so we can also reference to [Nat2000]_ in the ALGORITHMblock, even if it is in a separate file. However we would notinclude the reference here since it would cause a conflict.REFERENCES:.. [SC] Conventions for coding in sage.http://www.sagemath.org/doc/developer/conventions.html.• A TESTS block (optional), formatted just like EXAMPLES, for additional tests which should be part of theregression suite but are not illustrative enough to merit placement in EXAMPLES.Use the following template when documenting functions. Note the indentationdef point(self, x=1, y=2):r"""Return the point ‘(x^5,y)‘.INPUT:- ‘‘x‘‘ -- integer (default: 1) the description of the24 Chapter 4. Writing Code for Sage
Sage Developer’s Guide, Release 6.1.1argument ‘‘x‘‘ goes here. If it contains multiple lines, allthe lines after the first need to begin at the same indentationas the backtick.- ‘‘y‘‘ -- integer (default: 2) the ...OUTPUT:The point as a tuple... SEEALSO:::func:‘line‘EXAMPLES:This example illustrates ...::sage: A = ModuliSpace()sage: A.point(2,3)xxxWe now ...::sage: B = A.point(5,6)sage: xxxIt is an error to ...::sage: C = A.point(’x’,7)Traceback (most recent call last):...TypeError: unable to convert x (=r) to an integer.. NOTE::...This function uses the algorithm of [BCDT]_ to determinewhether an elliptic curve ‘E‘ over ‘Q‘ is modular.REFERENCES:.. [BCDT] Breuil, Conrad, Diamond, Taylor,"Modularity ....""""You are strongly encouraged to:• Use nice LaTeX formatting everywhere, see LaTeX Typesetting.• Liberally describe what the examples do. Note that there must be a blank line after the example code and beforethe explanatory text for the next example (indentation is not enough).4.1. General Conventions 25
Page 1: Sage Developer’s GuideRelease 6.1
Page 4 and 5: 7 Indices and tables 129Bibliograph
Page 6 and 7: Sage Developer’s Guide, Release 6
Page 78 and 79:
Sage Developer’s Guide, Release 6
Page 80 and 81:
Page 82 and 83:
Page 84 and 85:
Page 86 and 87:
Page 88 and 89:
Page 90 and 91:
Page 92 and 93:
Page 94 and 95:
Page 96 and 97:
Page 98 and 99:
Page 100 and 101:
Page 102 and 103:
Page 104 and 105:
Page 106 and 107:
Page 108 and 109:
Page 110 and 111:
Page 112 and 113:
Page 114 and 115:
Page 116 and 117:
Page 118 and 119:
Page 120 and 121:
Page 122 and 123:
Page 124 and 125:
Page 126 and 127:
Page 128 and 129:
Page 130 and 131:
Page 132 and 133:
Page 134 and 135:
Page 136 and 137:
show all

Sage Developer's Guide - Mirrors

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?