Skip to content

Commit 6080531

Browse files
author
Greg Taylor
committed
Updating comments, prepping for 1.0 release.
1 parent 034b747 commit 6080531

File tree

55 files changed

+8246
-13
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+8246
-13
lines changed

docs/api-objects.txt

Lines changed: 103 additions & 0 deletions
Large diffs are not rendered by default.

docs/class-tree.html

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
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>Class Hierarchy</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+
<!-- Home link -->
18+
<th>&nbsp;&nbsp;&nbsp;<a
19+
href="workspace.python-fedex.fedex-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20+
21+
<!-- Tree link -->
22+
<th bgcolor="#70b0f0" class="navbar-select"
23+
>&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>
24+
25+
<!-- Index link -->
26+
<th>&nbsp;&nbsp;&nbsp;<a
27+
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28+
29+
<!-- Help link -->
30+
<th>&nbsp;&nbsp;&nbsp;<a
31+
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32+
33+
<!-- Project homepage -->
34+
<th class="navbar" align="right" width="100%">
35+
<table border="0" cellpadding="0" cellspacing="0">
36+
<tr><th class="navbar" align="center"
37+
><a class="navbar" target="_top" href="http://code.google.com/p/python-fedex/">python-fedex</a></th>
38+
</tr></table></th>
39+
</tr>
40+
</table>
41+
<table width="100%" cellpadding="0" cellspacing="0">
42+
<tr valign="top">
43+
<td width="100%">&nbsp;</td>
44+
<td>
45+
<table cellpadding="0" cellspacing="0">
46+
<!-- hide/show private -->
47+
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
48+
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
49+
<tr><td align="right"><span class="options"
50+
>[<a href="frames.html" target="_top">frames</a
51+
>]&nbsp;|&nbsp;<a href="class-tree.html"
52+
target="_top">no&nbsp;frames</a>]</span></td></tr>
53+
</table>
54+
</td>
55+
</tr>
56+
</table>
57+
<center><b>
58+
[ <a href="module-tree.html">Module Hierarchy</a>
59+
| <a href="class-tree.html">Class Hierarchy</a> ]
60+
</b></center><br />
61+
<h1 class="epydoc">Class Hierarchy</h1>
62+
<ul class="nomargin-top">
63+
<li> <strong class="uidlink">object</strong>:
64+
<em class="summary">The most base type</em>
65+
<ul>
66+
<li> <strong class="uidlink">exceptions.BaseException</strong>:
67+
<em class="summary">Common base class for all exceptions</em>
68+
<ul>
69+
<li> <strong class="uidlink">exceptions.Exception</strong>:
70+
<em class="summary">Common base class for all non-exit exceptions.</em>
71+
<ul>
72+
<li> <strong class="uidlink"><a href="workspace.python-fedex.fedex.base_service.FedexBaseServiceException-class.html">workspace.python-fedex.fedex.base_service.FedexBaseServiceException</a></strong>:
73+
<em class="summary">Serves as the base exception that other service-related exception
74+
objects are sub-classed from.</em>
75+
<ul>
76+
<li> <strong class="uidlink"><a href="workspace.python-fedex.fedex.base_service.FedexError-class.html">workspace.python-fedex.fedex.base_service.FedexError</a></strong>:
77+
<em class="summary">These are generally problems with the client-provided data.</em>
78+
<ul>
79+
<li> <strong class="uidlink"><a href="workspace.python-fedex.fedex.services.track_service.FedexInvalidTrackingNumber-class.html">workspace.python-fedex.fedex.services.track_service.FedexInvalidTrackingNumber</a></strong>:
80+
<em class="summary">Sent when a bad tracking number is provided.</em>
81+
</li>
82+
</ul>
83+
</li>
84+
<li> <strong class="uidlink"><a href="workspace.python-fedex.fedex.base_service.FedexFailure-class.html">workspace.python-fedex.fedex.base_service.FedexFailure</a></strong>:
85+
<em class="summary">The request could not be handled at this time.</em>
86+
</li>
87+
<li> <strong class="uidlink"><a href="workspace.python-fedex.fedex.base_service.SchemaValidationError-class.html">workspace.python-fedex.fedex.base_service.SchemaValidationError</a></strong>:
88+
<em class="summary">There is probably a problem in the data you provided.</em>
89+
</li>
90+
</ul>
91+
</li>
92+
</ul>
93+
</li>
94+
</ul>
95+
</li>
96+
<li> <strong class="uidlink"><a href="workspace.python-fedex.fedex.base_service.FedexBaseService-class.html">workspace.python-fedex.fedex.base_service.FedexBaseService</a></strong>:
97+
<em class="summary">This class is the master class for all Fedex request objects.</em>
98+
<ul>
99+
<li> <strong class="uidlink"><a href="workspace.python-fedex.fedex.services.ship_service.FedexDeleteShipmentRequest-class.html">workspace.python-fedex.fedex.services.ship_service.FedexDeleteShipmentRequest</a></strong>:
100+
<em class="summary">This class allows you to delete a shipment, given a tracking
101+
number.</em>
102+
</li>
103+
<li> <strong class="uidlink"><a href="workspace.python-fedex.fedex.services.ship_service.FedexProcessShipmentRequest-class.html">workspace.python-fedex.fedex.services.ship_service.FedexProcessShipmentRequest</a></strong>:
104+
<em class="summary">This class allows you to track shipments by providing a tracking
105+
number or other identifying features.</em>
106+
</li>
107+
<li> <strong class="uidlink"><a href="workspace.python-fedex.fedex.services.track_service.FedexTrackRequest-class.html">workspace.python-fedex.fedex.services.track_service.FedexTrackRequest</a></strong>:
108+
<em class="summary">This class allows you to track shipments by providing a tracking
109+
number or other identifying features.</em>
110+
</li>
111+
</ul>
112+
</li>
113+
<li> <strong class="uidlink"><a href="workspace.python-fedex.fedex.config.FedexConfig-class.html">workspace.python-fedex.fedex.config.FedexConfig</a></strong>:
114+
<em class="summary">Base configuration class that is used for the different Fedex SOAP
115+
calls.</em>
116+
</li>
117+
</ul>
118+
</li>
119+
</ul>
120+
<!-- ==================== NAVIGATION BAR ==================== -->
121+
<table class="navbar" border="0" width="100%" cellpadding="0"
122+
bgcolor="#a0c0ff" cellspacing="0">
123+
<tr valign="middle">
124+
<!-- Home link -->
125+
<th>&nbsp;&nbsp;&nbsp;<a
126+
href="workspace.python-fedex.fedex-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
127+
128+
<!-- Tree link -->
129+
<th bgcolor="#70b0f0" class="navbar-select"
130+
>&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>
131+
132+
<!-- Index link -->
133+
<th>&nbsp;&nbsp;&nbsp;<a
134+
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
135+
136+
<!-- Help link -->
137+
<th>&nbsp;&nbsp;&nbsp;<a
138+
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
139+
140+
<!-- Project homepage -->
141+
<th class="navbar" align="right" width="100%">
142+
<table border="0" cellpadding="0" cellspacing="0">
143+
<tr><th class="navbar" align="center"
144+
><a class="navbar" target="_top" href="http://code.google.com/p/python-fedex/">python-fedex</a></th>
145+
</tr></table></th>
146+
</tr>
147+
</table>
148+
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
149+
<tr>
150+
<td align="left" class="footer">
151+
Generated by Epydoc 3.0.1 on Wed Sep 23 15:39:17 2009
152+
</td>
153+
<td align="right" class="footer">
154+
<a target="mainFrame" href="http://epydoc.sourceforge.net"
155+
>http://epydoc.sourceforge.net</a>
156+
</td>
157+
</tr>
158+
</table>
159+
160+
<script type="text/javascript">
161+
<!--
162+
// Private objects are initially displayed (because if
163+
// javascript is turned off then we want them to be
164+
// visible); but by default, we want to hide them. So hide
165+
// them unless we have a cookie that says to show them.
166+
checkCookie();
167+
// -->
168+
</script>
169+
</body>
170+
</html>

docs/crarr.png

340 Bytes
Loading

0 commit comments

Comments
 (0)