-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Philip Olson wrote:
> We don't really follow the "Release Early, Release Often" mantra in the
> documentation because bogus information should never be in the docs.
> And sometimes it becomes forgotten so the bogus information remains.
That makes sense. I would personally get very mad if I wasted an hour
because of incorrect documentation.
Philip Olson wrote:
> Please remove/update the parameter listings and return value roles.
> It's okay to leave them blank (for now) but users should never see
> that developer information from xml_proto.php like "Its description"
> and "&return.success;"
Jakub Vrana wrote:
> Instructions for documentors ("Its description", "What the function
> returns") should be at least removed, better replaced with real
> documentation.
As I said, they're just skeleton files, no "new" documentation per-say.
> Several return types are wrong (even in the source protos). But don't
> worry about it, I'll fix that after commit with my tool.
Hmm... that's interesting. I actually had to add a few new protos and
fix a few incorrect summaries when I ran the script. I'll probably have
to deal with them when I comb through each function and add detailed
documentation, so it would be helpful if I knew about it now.
> It's not necessary to duplicate refpurpose to para after
> methodsynopsis. It's better to shorten refpurpose and prolong this
> para where possible (e.g. svn_diff).
Will do. The skeleton script automatically duplicates it, but I
definitely see how this is not the best behavior.
Philip Olson wrote:
> Take a deeeeep breath... count to 42... there really is no rush here ;)
Of course. :-)
- --
Edward Z. Yang Personal: [EMAIL PROTECTED]
SN:Ambush Commander Website: http://www.thewritingpot.com/
GPGKey:0x869C48DA http://www.thewritingpot.com/gpgpubkey.asc
3FA8 E9A9 7385 B691 A6FC B3CB A933 BE7D 869C 48DA
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (MingW32)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org
iD8DBQFGE6p2qTO+fYacSNoRAjY/AJ43Zbq+hH2n9yKF/bIk3y9pLzVc9ACeNqdS
JcdVf6sOrKqcnODLgv83b7g=
=+IsY
-----END PGP SIGNATURE-----
