1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
|
<?xml version="1.0"?>
<page id="Regress.TestObj.torture_signature_1"
type="topic"
style="method"
xmlns="http://projectmallard.org/1.0/"
xmlns:api="http://projectmallard.org/experimental/api/"
xmlns:ui="http://projectmallard.org/1.0/ui/">
<info>
<link xref="Regress.TestObj" group="method" type="guide"/>
<api:function>
<api:returns>
<api:type>bool</api:type>
</api:returns>
<api:name>regress_test_obj_torture_signature_1</api:name>
<api:arg>
<api:type>Regress.TestObj</api:type>
<api:name>self</api:name>
</api:arg>
<api:arg>
<api:type>int</api:type>
<api:name>x</api:name>
</api:arg>
<api:arg>
<api:type>float</api:type>
<api:name>y</api:name>
</api:arg>
<api:arg>
<api:type>int</api:type>
<api:name>z</api:name>
</api:arg>
<api:arg>
<api:type>unicode</api:type>
<api:name>foo</api:name>
</api:arg>
<api:arg>
<api:type>int</api:type>
<api:name>q</api:name>
</api:arg>
<api:arg>
<api:type>int</api:type>
<api:name>m</api:name>
</api:arg>
</api:function>
</info>
<title>Regress.TestObj.torture_signature_1</title>
<synopsis><code mime="text/x-python">
@accepts(Regress.TestObj, int, float, int, unicode, int, int)
@returns(bool)
def torture_signature_1(self, x, y, z, foo, q, m):
# Python wrapper for regress_test_obj_torture_signature_1()
</code></synopsis>
<p>This function throws an error if m is odd.</p>
<terms>
<item>
<title><code>self</code></title>
<p>A <link xref="Regress.TestObj"/></p>
</item>
<item>
<title><code>x</code></title>
</item>
<item>
<title><code>y</code></title>
</item>
<item>
<title><code>z</code></title>
</item>
<item>
<title><code>foo</code></title>
</item>
<item>
<title><code>q</code></title>
</item>
<item>
<title><code>m</code></title>
</item>
<item>
<title><code>Returns</code></title>
{formatter.format(node, node.retval.doc)}
</item>
</terms>
</page>
|