[Tutor] doc strings and structured text
W. Jarrett Campbell
jarrett@ydyn.com
Tue, 12 Jun 2001 16:11:45 -0500
This is a multi-part message in MIME format.
------=_NextPart_000_0013_01C0F35A.604CDC70
Content-Type: multipart/alternative;
boundary="----=_NextPart_001_0014_01C0F35A.604CDC70"
------=_NextPart_001_0014_01C0F35A.604CDC70
Content-Type: text/plain;
charset="iso-8859-1"
Content-Transfer-Encoding: 7bit
In my new python adventure I've seen lots of reference to 'doc strings' and
'structured text'. I've even figured out how to generate some basic inline
documentation using the ActiveState implementation of pydoc. However, I
haven't been able to find a really good, tutorial level reference explaining
doc strings and structured text.
Does anyone have suggestions for some background reading on these topics.
Thank you,
Jarrett
W. Jarrett Campbell, Ph.D.
Member of the Technical Staff
Yield Dynamics, Inc.
5838 Balcones Drive, Ste. 101
Austin, TX 78731
512.323.9149 office
512.257.9503 fax
512.415.1078 mobile
jarrett@ydyn.com
http://www.ydyn.com
------=_NextPart_001_0014_01C0F35A.604CDC70
Content-Type: text/html;
charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD>
<META http-equiv=3DContent-Type content=3D"text/html; =
charset=3Diso-8859-1">
<META content=3D"MSHTML 5.50.4616.200" name=3DGENERATOR></HEAD>
<BODY>
<DIV><SPAN class=3D063081021-12062001><FONT face=3DArial size=3D2>In my =
new python=20
adventure I've seen lots of reference to 'doc strings' and 'structured=20
text'. I've even figured out how to generate some basic inline=20
documentation using the ActiveState implementation of pydoc. =
However, I=20
haven't been able to find a really good, tutorial level reference =
explaining doc=20
strings and structured text.</FONT></SPAN></DIV>
<DIV><SPAN class=3D063081021-12062001><FONT face=3DArial=20
size=3D2></FONT></SPAN> </DIV>
<DIV><SPAN class=3D063081021-12062001><FONT face=3DArial size=3D2>Does =
anyone have=20
suggestions for some background reading on these=20
topics.</FONT></SPAN></DIV><SPAN class=3D063081021-12062001>
<DIV><BR><FONT face=3DArial size=3D2>Thank you,</FONT></DIV>
<DIV><FONT face=3DArial size=3D2></FONT> </DIV>
<DIV></SPAN><SPAN class=3D063081021-12062001><FONT face=3DArial=20
size=3D2>Jarrett</FONT></SPAN></DIV>
<P><FONT face=3DArial size=3D2></FONT> </P>
<TABLE width=3D312>
<TBODY>
<TR>
<TD align=3Dleft width=3D304 colSpan=3D2>
<P align=3Dleft><IMG height=3D66 =
src=3D"cid:063081021@12062001-19aa" width=3D250=20
border=3D0> </P></TD></TR>
<TR>
<TD align=3Dleft width=3D179><FONT size=3D1>W. Jarrett Campbell, =
Ph.D.<BR>Member=20
of the Technical Staff<BR>Yield Dynamics, Inc.<BR>5838 Balcones =
Drive,=20
Ste. 101<BR>Austin, TX 78731<BR></FONT></TD>
<TD align=3Dleft width=3D119><FONT size=3D1>512.323.9149 =20
office<BR>512.257.9503 fax<BR>512.415.1078 =
mobile<BR><A=20
href=3D"mailto:jarrett@ydyn.com">jarrett@ydyn.com</A><BR><A=20
=
href=3D"http://www.ydyn.com/">http://www.ydyn.com<BR></A></FONT></TD></TR=
></TBODY></TABLE>
<DIV> </DIV></BODY></HTML>
------=_NextPart_001_0014_01C0F35A.604CDC70--
------=_NextPart_000_0013_01C0F35A.604CDC70
Content-Type: image/gif;
name="signature.gif"
Content-Transfer-Encoding: base64
Content-ID: <063081021@12062001-19aa>
R0lGODlh+gBCALMAAAgICCQkJEVFRV5eXnNzc4iIiJycnK2trbW1tcXFxdbW1t7e3ufn5+/v7/f3
9////ywAAAAA+gBCAAAE/vDJSau9OOvNu/9gKI5kWS0GY65s675wLHNIAChzru9871sNwwBAcPyO
yKRyGRQQBIuldEqtihjPRuFg7Xq/U4ZAoEAYGhkHooADu99wjyO7IGcYBpshzu/zHQUBCQ8GAkYX
DAECCQZcfo+QVQgAgwwDbRYKAgMMDQRRkaGiPg5CEgwIhxViA2gFAmgjDAoEtQeqo7kYDrhgWQ8L
ghdzAWgOA44gDgwHAwMGjQMIutQVDgoDRS29Kw1jRkIqQASOCa0h2NkK4g8JBLHVurQCAAbcIgsD
oC0JATiWmCoc0AYoWQc8AT71EhMwXqQgTwLsaaHghotS9tqdAyKggIQa/uw4FCpwBhEUh6EcHBiD
rcC9KwQstgAooYDHCwcCiBPykoIDd880iNmHsg+tAJwChTRhAMCAQS1APrAE1cITIw1ucdCyaamF
oUX9pFMQxEBDEwOcVF2R7cGxAfcaBJj2YCA8DAueLOg5IR/RsGC0SHT76m43AGvoHp5mzqsETSoa
XNKg5pnjCzYBa2igoNEBaDZtQmvUCYY7AakeYDtrAjIBxSYYUCqYQROaWhtqrOVAYKIIBw0SJDDs
hdeCBCvpAVgeIHQg5h3LKOBVQo2iWIBuXiTQShqLOXATCLisGpZc30AQPONrFf2HvM4Gg7lWK9um
Bg14UZ+gv8ECPJvU/pJaCJ48EwstBRDXmj/HwEaCNwmA1xM2WSWIgWT6hGDJX1s1Y8Bw/40AHHu/
1YDUAXs5oUwDzAxkxwfYpMBfVzEcAEB+3nUDRWMaNCOZgxQg8IkIhSlDQHMkpoFFNgqSwEAgBFTl
jUEaElAAeT7lYQgFeWBJQiFu5WiCZFpQaY0zG+I1GYEqyiFkSSQsM8QiY7hQAAAHLJWmT0lOsJKX
gMyFS05msiCXRzStoAkC421QADIZAUFSnxTsycFPSJbgSUcoPjBJkyB4s1GlJ01giWL6pfrVIkLl
4SArlH4gxiDqxYqBjQmxJ1ujF5gDqlsYGECAB5IVwCEIQj6lyqeG/grgngSSibMMPR0VUAt3zjC5
ijAY9GNhBV3OYIkKtbIwyYCbZdora8B1VqpPJHWQVYZx1gDLCbyacAxqCCSAAAIHBOzsSgEUXPAY
zgIccMC9JCCTNf3ca4EZOTCKhgEumQsAiSrBtQvGuPyUbS3EFeLlVCSboN4BxPVzcgd5LSfzM/Q4
h9o7+nWQzT2BfGvBfjJcVcexIqzUgQJITdgcAwlYy52zL0m4gSaRjrBAIIV6euMLwOEXSyCHdFbX
rwL5c0ENGStxVR6/Ap2BwwJsZdOoZytiZQEI5KcBLUT3ZRPZGtSB2kt32hpCwdAiwwaMbVaAdNpJ
zOGRlbllPUGB/gBgWSCZG/gHuJ8EKSjGs0bSbU1zOzSAZ5iomd1BDawhveUScyiQD9mNX+DJO2vq
fqTt+VJkxxwS90UjCZoQgKV4rLmgBWJhPlV1BkG09fMrzZNi5VM+RUhBP5bvi4N4HP6E/QNyWT4C
d8AdGTwhxf82BpbHDKuDsNA/kJaxHAA43fXx28E1bFeBmGzNePtIRAApgDSoOMBZFcjKdSZAjhcE
YzgDKMaQoHUAn5UINRvoR9/4RIEGrAFOpViLGHIClSGoDzhNUV638scDNTzBGTKUwJEclAdVVMR+
ktogtJy2PQBAjQKPusgW8MCGPUkmhyIaiJc8AZt7qGEToDiG/sFuYiNtEKaDHtPf++DVkeFcqDeG
+00zENCJikBFMrOjIIOCQw/WbGo3UxkNNPJkgUB8rn/6mBQwTqISKI6gBuqTwEAOoQVDKjIh3yjF
XPRXhAcSoS+ccIYR3hIXYQ3Agxaow8vMFYBkOOwf7sNFMASQkAxughsEyx4NdMKP3mgFftdwwih3
gcbcCAMhzVEPBXJiD7BVhAuPmwpSQJEXe7CvM3lI2zKaoYgriaQYbrplCDrCSCdIMAXxQl8HySIc
BCwgGJhQw0h2aZIRfiAP75gA9ua3Al91zpt1MCIObBQLydjDRh455QP8SIj8EUMFwQgELJqCGnPQ
4yl/BJu8/u6UuSvQMCffNIKNEqCAO2mHP85QgEhjwgkWWKoEk6ClqQoWzwsd7UVpIClSjGgEuCUO
Ubl6RRQeaI88eMxb4sAQnMyRrbyF4BX9C8QnFTSiDJjBGEIyQ1CG6AwD7OUC+cgW95z3nfNVgKM9
8YQsFbkxa6jCE8t5SiJugQ3EMO18DvMX6tBHhCMhxYTOuIvb3IKfNIrHMctgRME+xD9eMM0MihCG
fpimAPEcIAHMUMTx+NNXyngtjTX8ozVktIGBCIR7S3IKVBiFBYOlpR6xiFjwhEQA2yX2fwIUAmyB
kxdWDsEZCLvWQ22RwfocSWYAeJRylqaZI9ioE8ywbUdt/sCgCSDNiGdISwKuKoGfQPZnhxAOO1tD
j+YYsKGdeMIZsDCGfk3nEA8cw4c4ysRjQFezxaWIIk77lNpCyQKfwQ5mlZAVjJHkQ9Yg4TD2mplX
bDe+2zgnA1TilFlwE8EzSF87vAjhI1xDSALIU/L2W+G33atcHf6BjciABnfAKcQvuIqnwojiHDjg
ahJBg2Tq0eIYqBjENY5BKTqSGmKwLMcp3hKOgfydgXzyco9yJ5FBcGMWL7kE+UjIVc1n1Se7QMXW
4vCTBUeUpjjZyia4ijcoDOYPBAqKHTVQmVsg5t6teaKCMl5F38yCq0CGzh3ox1bR59MD49kChRAM
fMHcc4+WXiODP/7zCkqRk48q+qtqloCex/poDwiJhpWeQD98czWYZnpMrMTjo5EWz5+U99MuEI6W
Q1ysTULJz6iOdUy1cRTvyfrWLBjI+JAialz7Wlb+eNInV/1rWcPtGbAttrJB4DAhLvvZcjAjtKdN
bVxHAAAAOw==
------=_NextPart_000_0013_01C0F35A.604CDC70--