[Pidgin] StyleGuide modified

[Pidgin]

Page "StyleGuide" was changed by MarkDoliner
Diff URL: <https://developer.pidgin.im/wiki/StyleGuide?action=diff&version=15>
Revision 15
Comment: Add note about self-documenting code, and a few other working tweaks.
Changes:
-------8<------8<------8<------8<------8<------8<------8<------8<--------
Index: StyleGuide
=========================================================================
--- StyleGuide (version: 14)
+++ StyleGuide (version: 15)
@@ -54,8 +54,9 @@
 
 
 == Comments ==
- * A comment or two in the static (non-exported) functions is good, but not essential.
- * Function declarations in header files must be documented. See our other header files for examples. (If you find an undocumented or poorly documented function, please do submit a patch fixing it!)
+ * Code should be self-documenting. If the code you're writing does something non-obvious, add a comment to help future developers understand what's happening.
+ * Function declarations in header files must be documented. See our existing header files for examples. (If you find an undocumented or poorly documented function, please submit a patch to fix it!)
+ * Documenting static (non-exported) functions is good, but not essential.
  * Only use C89 comments, not C++/C99 one-line comments:
 
 {{{
-------8<------8<------8<------8<------8<------8<------8<------8<--------

--
Page URL: <https://developer.pidgin.im/wiki/StyleGuide>
Pidgin <https://pidgin.im>
Pidgin

This is an automated message. Someone added your email address to be
notified of changes on 'StyleGuide' page.
If it was not you, please report to datallah at pidgin.im.