<div dir="ltr">So there is a good rule-of-thumb, it doesn't just apply to Python though. It's buried in the python packages. Try doing the below in a Python CLI.<div><br></div><div><font face="monospace">import this</font></div><div><br></div><div>~Carl</div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Sat, Apr 23, 2022 at 9:07 PM Bill Trautman via TriEmbed <<a href="mailto:triembed@triembed.org">triembed@triembed.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div>
<div>Trampas, <br>
</div>
<div><br>
</div>
<div>I agree simple is better than cute or
complicated. break up complicated code. let the compiler do
what it can with it to make it more efficient. Likely not a lot
different from the result of doing the 'cute' code.</div>
<div><br>
</div>
<div>Scott, <br>
<br>
Documentation needs to cover the things that are not obvious. I
always write it to myself to explain it to myself in a few months
assuming I completely forgot why I did something the way i did. I
try and leave enough info for me and the next person out of
kindness :-)<br>
<br>
<br>
</div>
<div><br>
</div>
<div>On 4/23/2022 12:09 PM, Scott Hall via
TriEmbed wrote:<br>
</div>
<blockquote type="cite">
<div dir="ltr">
<div>Doxygen (<a href="https://www.doxygen.nl/index.html" target="_blank">https://www.doxygen.nl/index.html</a>)
was always my goto tool for code documentation, and help in
reverse engineering someone else's code (including my own
after a year or more) for altering or updating code. And it
has been around since the mid-1990's.</div>
<div><br>
</div>
<div>- sgh<br>
</div>
</div>
<br>
<div class="gmail_quote">
<div dir="ltr" class="gmail_attr">On Sat, Apr 23, 2022 at 11:33
AM Trampas Stern via TriEmbed <<a href="mailto:triembed@triembed.org" target="_blank">triembed@triembed.org</a>>
wrote:<br>
</div>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div dir="ltr">
<div>I have some rules which I follow with code, the number
1 rule is:</div>
<div><br>
</div>
<b>Code must be understandable by the next person.</b>
<div><br>
</div>
<div>If you need a tool to explain the code you have
failed. However if you are learning C and want to
understand the basics then it might be a good learning
tool. <br>
</div>
<div><br>
</div>
<div>Note I have the rule above and strive to meet it, but I
often fail. Seems the next guy is never as smart as I was,
especially when the next guy is me in a few days/months. </div>
<div><br>
</div>
<div>Trampas</div>
<div><br>
</div>
</div>
</blockquote>
</div>
</blockquote>
<br>
</div>
_______________________________________________<br>
Triangle, NC Embedded Interest Group mailing list<br>
<br>
To post message: <a href="mailto:TriEmbed@triembed.org" target="_blank">TriEmbed@triembed.org</a><br>
List info: <a href="http://mail.triembed.org/mailman/listinfo/triembed_triembed.org" rel="noreferrer" target="_blank">http://mail.triembed.org/mailman/listinfo/triembed_triembed.org</a><br>
TriEmbed web site: <a href="https://TriEmbed.org" rel="noreferrer" target="_blank">https://TriEmbed.org</a><br>
To unsubscribe, click link and send a blank message: mailto:<a href="mailto:unsubscribe-TriEmbed@bitser.net" target="_blank">unsubscribe-TriEmbed@bitser.net</a>?subject=unsubscribe<br>
Searchable email archive available at <a href="https://www.mail-archive.com/triembed@triembed.org/" rel="noreferrer" target="_blank">https://www.mail-archive.com/triembed@triembed.org/</a><br>
<br>
</blockquote></div><br clear="all"><div><br></div>-- <br><div dir="ltr" class="gmail_signature"><div dir="ltr">--------------------------------------------------------------<br>Carl J. Nobile (Software Engineer/API Design)<br><a href="mailto:carl.nobile@gmail.com" target="_blank">carl.nobile@gmail.com</a><br>--------------------------------------------------------------</div></div>