<div dir="ltr"><div><div>Petko --I don't think I'm going to change your mind or development methods, but I wanted to put in my two cents.<br><br>It's good that most code-related documentation does ship with the code (although as Oliver has pointed out -- some of it is in the Cookbook, which does not).<br>

<br>However, that's still external documentation, and nowhere near self-documenting code -- and the introduction semantic names for variables or methods is a common refactoring. It's certainly not obvious staring at php code that the lookup-table is over in the wiki.d folder.<br>

<br></div><div>If the code is confusing to you, the lead developer -- just think how it looks to outsiders who would like to contribute to the project, but are left staring at a codebase that seems more akin to a DSL.<br>

<br></div><div><br></div><div>This is not meant as an attack -- you and Pm (and others, but you two as lead and originator) have done an incredible job. I want to contribute, and if there is some way I can help with the problems I've raised, please let me know.<br>

<br>How can one contribute to the code? I'm not finding it quickly on the wiki -- the contributors page lists contributors, but not how to do it: <a href="http://www.pmwiki.org/wiki/PmWiki/Contributors">http://www.pmwiki.org/wiki/PmWiki/Contributors</a><br>

<br></div><div>The SVN page only discusses how to pull  the code, not to offer changes: <a href="http://www.pmwiki.org/wiki/PmWiki/Subversion">http://www.pmwiki.org/wiki/PmWiki/Subversion</a><br></div></div>
<br><br></div><div class="gmail_extra"><br clear="all"><div>-Michael Paulukonis<br><a href="http://www.xradiograph.com" target="_blank">http://www.xradiograph.com</a><br><a href="http://goog_2112721603" target="_blank"></a><a href="http://www.xradiograph.com%5Cinterference" target="_blank">Interference Patterns (a blog)</a><br>

<a href="https://twitter.com/XraysMonaLisa" target="_blank">@XraysMonaLisa</a><br><a href="http://michaelpaulukonis.com" target="_blank">http://michaelpaulukonis.com</a><br><a href="http://www.BestAndroidResources.com" target="_blank"></a><br>

<br>Sent from somewhere in the Cloud<br>(hearthrug, by the fender)<br></div>
<br><br><div class="gmail_quote">On Fri, Feb 7, 2014 at 8:36 PM, Petko Yotov <span dir="ltr"><<a href="mailto:5ko@5ko.fr" target="_blank">5ko@5ko.fr</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">

<div class="">michael paulukonis writes:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
If brevity is needed for performance reasons, can't the source be run through a minifier prior to packaging?<br>
</blockquote>
<br></div>
Some brevity is needed to me in order to keep my sanity and to be efficient. That includes writing less code, making less errors and seeing more of the program logic at once on my screen.<br>
<br>
When some helper functions are used tens or hundreds of times, it helps having short function names - abbreviations of the intended functionnality. I also feel that it is much easier to remember what the function does, compared to, for example, the order of its arguments (that's why I like most functions with a single argument :-).<br>


<br>
Also, these are just helper functions: they do some things that are required to be done, but are not essential to the grand program logic, and I want them out of my way.<div class=""><br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
   A program IS NOT communication between a human and the machine.<br>
   It’s a communication between a developer and the next developer.<br>
</blockquote>
<br></div>
It is also a communication between a developer and himself/herself.<div class=""><br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
The communication I receive from a function names like "PCCFR" or "XLSDV" or "PZZ" is "you are not worthy of contributing to this codebase until you memorize our secret language [hint: it only _looks_ like PHP]."<br>


</blockquote>
<br></div>
I'm willing to better document these functions if the current documentation is insufficient.<br>
<br>
There is absolutely no requirement for a developer to use these functions. A module can contain all necessary code without using any of the above or other core helper functions.<br>
<br>
For example, PHP has more than one way to define callback functions; ours PCCF() "PmWiki Create Callback Function" is tested and works with PHP 4.2 to 5.5 but you are not required to use it.<br>
<br>
Other example: you can escape some HTML entities in different ways; ours PHSC() "PmWiki HTML Special Chars" is tested and works with PHP 4.2 to 5.5, even when your text stream contains invalid characters for the default encoding, which changes in different PHP versions. But you are not required to use it: if you like, you can write your own functions, debug them and support them for your users. :-)<span class="HOEnZb"><font color="#888888"><br>


<br>
<br>
Petko</font></span><div class="im HOEnZb"><br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
[Petko, maybe you were making a joke by taking something to an extreme.]<br>
<br>
</blockquote>
<br>
</div><div class="HOEnZb"><div class="h5"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
On Fri, Feb 7, 2014 at 12:31 PM, Petko Yotov <<URL:mailto:<a href="mailto:5ko@5ko.fr" target="_blank">5ko@5ko.fr</a>><a href="mailto:5ko@5ko.fr" target="_blank">5ko@<u></u>5ko.fr</a>> wrote:<br>
<br>
   Instead of PCCF('function code', 'r'), I'd prefer writing simply    PCCFR('function code').<br>
<br>
   (... PmWiki Create Callback Function Return...)<br>
<br>
   Petko<br>
</blockquote>
<br>
<br>
______________________________<u></u>_________________<br>
pmwiki-users mailing list<br>
<a href="mailto:pmwiki-users@pmichaud.com" target="_blank">pmwiki-users@pmichaud.com</a><br>
<a href="http://www.pmichaud.com/mailman/listinfo/pmwiki-users" target="_blank">http://www.pmichaud.com/<u></u>mailman/listinfo/pmwiki-users</a><br>
</div></div></blockquote></div><br></div>