docs/epy/apiclient.errors.BatchError-class.html - Issue 6305043: Switch to epydoc for documenting library.

Side by Side Diff: docs/epy/apiclient.errors.BatchError-class.html

Issue 6305043: Switch to epydoc for documenting library. (Closed)

Patch Set: Revert old pydocs, they didn't really change. Created 12 years, 9 months ago

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.

Jump to:

View unified diff | Download patch

OLD	NEW
(Empty)
	1 <?xml version="1.0" encoding="ascii"?>

	2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

	3 "DTD/xhtml1-transitional.dtd">

	4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

	5 <head>

	6 <title>apiclient.errors.BatchError</title>

	7 <link rel="stylesheet" href="epydoc.css" type="text/css" />

	8 <script type="text/javascript" src="epydoc.js"></script>

	9 </head>

	10

	11 <body bgcolor="white" text="black" link="blue" vlink="#204080"

	12 alink="#204080">

	13 <!-- ==================== NAVIGATION BAR ==================== -->

	14 <table class="navbar" border="0" width="100%" cellpadding="0"

	15 bgcolor="#a0c0ff" cellspacing="0">

	16 <tr valign="middle">

	17

	18 <!-- Tree link -->

	19 <th>   <a

	20 href="module-tree.html">Trees</a>   </th>

	21

	22 <!-- Index link -->

	23 <th>   <a

	24 href="identifier-index.html">Indices</a>   </th>

	25

	26 <!-- Help link -->

	27 <th>   <a

	28 href="help.html">Help</a>   </th>

	29

	30 <th class="navbar" width="100%"></th>

	31 </tr>

	32 </table>

	33 <table width="100%" cellpadding="0" cellspacing="0">

	34 <tr valign="top">

	35 <td width="100%">

	36 <span class="breadcrumbs">

	37 <a href="apiclient-module.html">Package apiclient</a> ::

	38 <a href="apiclient.errors-module.html">Module errors</a> ::

	39 Class BatchError

	40 </span>

	41 </td>

	42 <td>

	43 <table cellpadding="0" cellspacing="0">

	44 <!-- hide/show private -->

	45 <tr><td align="right"><span class="options">[<a href="javascript:void(0) ;" class="privatelink"

	46 onclick="toggle_private();">hide private</a>]</span></td></tr>

	47 <tr><td align="right"><span class="options"

	48 >[<a href="frames.html" target="_top">frames</a

	49 >] \| <a href="apiclient.errors.BatchError-class.html"

	50 target="_top">no frames</a>]</span></td></tr>

	51 </table>

	52 </td>

	53 </tr>

	54 </table>

	55 <!-- ==================== CLASS DESCRIPTION ==================== -->

	56 <h1 class="epydoc">Class BatchError</h1><p class="nomargin-top"><span class="cod elink"><a href="apiclient.errors-pysrc.html#BatchError">source code</a></sp an></p>

	57 <center>

	58 <center> <map id="uml_class_diagram_for_apiclien" name="uml_class_diagram_for_a piclien">

	59 <area shape="rect" href="apiclient.errors.BatchError-class.html#__init__" title= "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" co ords="17,471,303,489"/>

	60 <area shape="rect" href="apiclient.errors.BatchError-class.html#__repr__" title= "str(x)" alt="" coords="17,489,303,508"/>

	61 <area shape="rect" href="apiclient.errors.BatchError-class.html#__str__" title=" str(x)" alt="" coords="17,508,303,527"/>

	62 <area shape="rect" href="apiclient.errors.BatchError-class.html" title="Error oc cured during batch operations." alt="" coords="16,445,304,528"/>

	63 <area shape="rect" href="apiclient.errors.HttpError-class.html" title="HTTP data was invalid or unexpected." alt="" coords="132,384,188,416"/>

	64 <area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.ar gs" alt="" coords="83,28,237,47"/>

	65 <area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.me ssage" alt="" coords="83,47,237,65"/>

	66 <area shape="rect" href="javascript:void(0);" title="x.__delattr__('name&#39 ;) <==> del x.name" alt="" coords="83,68,237,87"/>

	67 <area shape="rect" href="javascript:void(0);" title="x.__getattribute__('nam e') <==> x.name" alt="" coords="83,87,237,105"/>

	68 <area shape="rect" href="javascript:void(0);" title="x[y]" alt="" coords="83,105 ,237,124"/>

	69 <area shape="rect" href="javascript:void(0);" title="x[i:j]" alt="" coords="83,1 24,237,143"/>

	70 <area shape="rect" href="javascript:void(0);" title="helper for pickle" alt="" c oords="83,143,237,161"/>

	71 <area shape="rect" href="javascript:void(0);" title="x.__setattr__('name&#39 ;, value) <==> x.name = value" alt="" coords="83,161,237,180"/>

	72 <area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.__ setstate__" alt="" coords="83,180,237,199"/>

	73 <area shape="rect" href="javascript:void(0);" title="exceptions.BaseException.__ unicode__" alt="" coords="83,199,237,217"/>

	74 <area shape="rect" href="javascript:void(0);" title="Common base class for all e xceptions" alt="" coords="81,11,239,219"/>

	75 <area shape="rect" href="javascript:void(0);" title="exceptions.Exception.__new_ _" alt="" coords="97,273,223,292"/>

	76 <area shape="rect" href="javascript:void(0);" title="Common base class for all n on-exit exceptions." alt="" coords="96,248,224,293"/>

	77 <area shape="rect" href="apiclient.errors.Error-class.html" title="Base error fo r this module." alt="" coords="144,323,176,355"/>

	78 </map>

	79 <img src="uml_class_diagram_for_apiclien.gif" alt='' usemap="#uml_class_diagra m_for_apiclien" ismap="ismap" class="graph-without-title" />

	80 </center>

	81 </center>

	82 <hr />

	83 <pre class="literalblock">

	84 Error occured during batch operations.

	85

	86 </pre>

	87

	88 <!-- ==================== INSTANCE METHODS ==================== -->

	89 <a name="section-InstanceMethods"></a>

	90 <table class="summary" border="1" cellpadding="3"

	91 cellspacing="0" width="100%" bgcolor="white">

	92 <tr bgcolor="#70b0f0" class="table-header">

	93 <td colspan="2" class="table-header">

	94 <table border="0" cellpadding="0" cellspacing="0" width="100%">

	95 <tr valign="top">

	96 <td align="left"><span class="table-header">Instance Methods</span></td>

	97 <td align="right" valign="top"

	98 ><span class="options">[<a href="#section-InstanceMethods"

	99 class="privatelink" onclick="toggle_private();"

	100 >hide private</a>]</span></td>

	101 </tr>

	102 </table>

	103 </td>

	104 </tr>

	105 <tr>

	106 <td width="15%" align="right" valign="top" class="summary">

	107 <span class="summary-type"> </span>

	108 </td><td class="summary">

	109 <table width="100%" cellpadding="0" cellspacing="0" border="0">

	110 <tr>

	111 <td><span class="summary-sig"><a href="apiclient.errors.BatchError-cla ss.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig -arg">self</span>,

	112 <span class="summary-sig-arg">reason</span>,

	113 <span class="summary-sig-arg">resp</span>=<span class="summary-sig-defau lt">None</span>,

	114 <span class="summary-sig-arg">content</span>=<span class="summary-sig-de fault">None</span>)</span><br />

	115 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>

	116 <td align="right" valign="top">

	117 <span class="codelink"><a href="apiclient.errors-pysrc.html#BatchErr or.__init__">source code</a></span>

	118 ············

	119 </td>

	120 </tr>

	121 </table>

	122 ······

	123 </td>

	124 </tr>

	125 <tr>

	126 <td width="15%" align="right" valign="top" class="summary">

	127 <span class="summary-type"> </span>

	128 </td><td class="summary">

	129 <table width="100%" cellpadding="0" cellspacing="0" border="0">

	130 <tr>

	131 <td><span class="summary-sig"><a href="apiclient.errors.BatchError-cla ss.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig -arg">self</span>)</span><br />

	132 str(x)</td>

	133 <td align="right" valign="top">

	134 <span class="codelink"><a href="apiclient.errors-pysrc.html#BatchErr or.__repr__">source code</a></span>

	135 ············

	136 </td>

	137 </tr>

	138 </table>

	139 ······

	140 </td>

	141 </tr>

	142 <tr>

	143 <td width="15%" align="right" valign="top" class="summary">

	144 <span class="summary-type"> </span>

	145 </td><td class="summary">

	146 <table width="100%" cellpadding="0" cellspacing="0" border="0">

	147 <tr>

	148 <td><span class="summary-sig"><a href="apiclient.errors.BatchError-cla ss.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-a rg">self</span>)</span><br />

	149 str(x)</td>

	150 <td align="right" valign="top">

	151 <span class="codelink"><a href="apiclient.errors-pysrc.html#BatchErr or.__repr__">source code</a></span>

	152 ············

	153 </td>

	154 </tr>

	155 </table>

	156 ······

	157 </td>

	158 </tr>

	159 <tr>

	160 <td colspan="2" class="summary">

	161 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from < code><a href="apiclient.errors.HttpError-class.html">HttpError</a></code></b> (p rivate):

	162 <code><a href="apiclient.errors.HttpError-class.html#_get_reason" onclick= "show_private();">_get_reason</a></code>

	163 </p></div>

	164 <p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.Exception </code></b>:

	165 <code>__new__</code>

	166 </p>

	167 <p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.BaseExcep tion</code></b>:

	168 <code>__delattr__</code>,

	169 <code>__getattribute__</code>,

	170 <code>__getitem__</code>,

	171 <code>__getslice__</code>,

	172 <code>__reduce__</code>,

	173 <code>__setattr__</code>,

	174 <code>__setstate__</code>,

	175 <code>__unicode__</code>

	176 </p>

	177 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:

	178 <code>__format__</code>,

	179 <code>__hash__</code>,

	180 <code>__reduce_ex__</code>,

	181 <code>__sizeof__</code>,

	182 <code>__subclasshook__</code>

	183 </p>

	184 </td>

	185 </tr>

	186 </table>

	187 <!-- ==================== PROPERTIES ==================== -->

	188 <a name="section-Properties"></a>

	189 <table class="summary" border="1" cellpadding="3"

	190 cellspacing="0" width="100%" bgcolor="white">

	191 <tr bgcolor="#70b0f0" class="table-header">

	192 <td colspan="2" class="table-header">

	193 <table border="0" cellpadding="0" cellspacing="0" width="100%">

	194 <tr valign="top">

	195 <td align="left"><span class="table-header">Properties</span></td>

	196 <td align="right" valign="top"

	197 ><span class="options">[<a href="#section-Properties"

	198 class="privatelink" onclick="toggle_private();"

	199 >hide private</a>]</span></td>

	200 </tr>

	201 </table>

	202 </td>

	203 </tr>

	204 <tr>

	205 <td colspan="2" class="summary">

	206 <p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.BaseExcep tion</code></b>:

	207 <code>args</code>,

	208 <code>message</code>

	209 </p>

	210 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:

	211 <code>__class__</code>

	212 </p>

	213 </td>

	214 </tr>

	215 </table>

	216 <!-- ==================== METHOD DETAILS ==================== -->

	217 <a name="section-MethodDetails"></a>

	218 <table class="details" border="1" cellpadding="3"

	219 cellspacing="0" width="100%" bgcolor="white">

	220 <tr bgcolor="#70b0f0" class="table-header">

	221 <td colspan="2" class="table-header">

	222 <table border="0" cellpadding="0" cellspacing="0" width="100%">

	223 <tr valign="top">

	224 <td align="left"><span class="table-header">Method Details</span></td>

	225 <td align="right" valign="top"

	226 ><span class="options">[<a href="#section-MethodDetails"

	227 class="privatelink" onclick="toggle_private();"

	228 >hide private</a>]</span></td>

	229 </tr>

	230 </table>

	231 </td>

	232 </tr>

	233 </table>

	234 <a name="__init__"></a>

	235 <div>

	236 <table class="details" border="1" cellpadding="3"

	237 cellspacing="0" width="100%" bgcolor="white">

	238 <tr><td>

	239 <table width="100%" cellpadding="0" cellspacing="0" border="0">

	240 <tr valign="top"><td>

	241 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<s pan class="sig-arg">self</span>,

	242 <span class="sig-arg">reason</span>,

	243 <span class="sig-arg">resp</span>=<span class="sig-default">None</span>,

	244 <span class="sig-arg">content</span>=<span class="sig-default">None</spa n>)</span>

	245 <br /><em class="fname">(Constructor)</em>

	246 </h3>

	247 </td><td align="right" valign="top"

	248 ><span class="codelink"><a href="apiclient.errors-pysrc.html#BatchError.__in it__">source code</a></span>

	249 </td>

	250 </tr></table>

	251 ··

	252 <pre class="literalblock">

	253 x.__init__(...) initializes x; see x.__class__.__doc__ for signature

	254

	255 </pre>

	256 <dl class="fields">

	257 <dt>Overrides:

	258 object.__init__

	259 <dd><em class="note">(inherited documentation)</em></dd>

	260 </dt>

	261 </dl>

	262 </td></tr></table>

	263 </div>

	264 <a name="__repr__"></a>

	265 <div>

	266 <table class="details" border="1" cellpadding="3"

	267 cellspacing="0" width="100%" bgcolor="white">

	268 <tr><td>

	269 <table width="100%" cellpadding="0" cellspacing="0" border="0">

	270 <tr valign="top"><td>

	271 <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<s pan class="sig-arg">self</span>)</span>

	272 <br /><em class="fname">(Representation operator)</em>

	273 </h3>

	274 </td><td align="right" valign="top"

	275 ><span class="codelink"><a href="apiclient.errors-pysrc.html#BatchError.__re pr__">source code</a></span>

	276 </td>

	277 </tr></table>

	278 ··

	279 <pre class="literalblock">

	280 str(x)

	281

	282 </pre>

	283 <dl class="fields">

	284 <dt>Overrides:

	285 object.__repr__

	286 <dd><em class="note">(inherited documentation)</em></dd>

	287 </dt>

	288 </dl>

	289 </td></tr></table>

	290 </div>

	291 <a name="__str__"></a>

	292 <div>

	293 <table class="details" border="1" cellpadding="3"

	294 cellspacing="0" width="100%" bgcolor="white">

	295 <tr><td>

	296 <table width="100%" cellpadding="0" cellspacing="0" border="0">

	297 <tr valign="top"><td>

	298 <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<sp an class="sig-arg">self</span>)</span>

	299 <br /><em class="fname">(Informal representation operator)</em>

	300 </h3>

	301 </td><td align="right" valign="top"

	302 ><span class="codelink"><a href="apiclient.errors-pysrc.html#BatchError.__re pr__">source code</a></span>

	303 </td>

	304 </tr></table>

	305 ··

	306 <pre class="literalblock">

	307 str(x)

	308

	309 </pre>

	310 <dl class="fields">

	311 <dt>Overrides:

	312 object.__str__

	313 <dd><em class="note">(inherited documentation)</em></dd>

	314 </dt>

	315 </dl>

	316 </td></tr></table>

	317 </div>

	318 <br />

	319 <!-- ==================== NAVIGATION BAR ==================== -->

	320 <table class="navbar" border="0" width="100%" cellpadding="0"

	321 bgcolor="#a0c0ff" cellspacing="0">

	322 <tr valign="middle">

	323

	324 <!-- Tree link -->

	325 <th>   <a

	326 href="module-tree.html">Trees</a>   </th>

	327

	328 <!-- Index link -->

	329 <th>   <a

	330 href="identifier-index.html">Indices</a>   </th>

	331

	332 <!-- Help link -->

	333 <th>   <a

	334 href="help.html">Help</a>   </th>

	335

	336 <th class="navbar" width="100%"></th>

	337 </tr>

	338 </table>

	339 <table border="0" cellpadding="0" cellspacing="0" width="100%%">

	340 <tr>

	341 <td align="left" class="footer">

	342 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012

	343 </td>

	344 <td align="right" class="footer">

	345 <a target="mainFrame" href="http://epydoc.sourceforge.net"

	346 >http://epydoc.sourceforge.net</a>

	347 </td>

	348 </tr>

	349 </table>

	350

	351 <script type="text/javascript">

	352 <!--

	353 // Private objects are initially displayed (because if

	354 // javascript is turned off then we want them to be

	355 // visible); but by default, we want to hide them. So hide

	356 // them unless we have a cookie that says to show them.

	357 checkCookie();

	358 // -->

	359 </script>

	360 </body>

	361 </html>

OLD	NEW

« no previous file with comments | « docs/epy/apiclient.errors-pysrc.html ('k') | docs/epy/apiclient.errors.Error-class.html » ('j') | no next file with comments »