[Jifty-commit] r1880 -
jifty-commit at lists.jifty.org
jifty-commit at lists.jifty.org
Wed Aug 30 17:42:18 EDT 2006
Author: schwern
Date: Wed Aug 30 17:42:18 2006
New Revision: 1880
Added:
jifty/trunk/lib/Jifty/Manual/Style.pod
Modified:
/ (props changed)
Log:
r17560 at windhund: schwern | 2006-08-30 15:26:41 -0400
The beginnings of a Jifty code style guide.
Added: jifty/trunk/lib/Jifty/Manual/Style.pod
==============================================================================
--- (empty file)
+++ jifty/trunk/lib/Jifty/Manual/Style.pod Wed Aug 30 17:42:18 2006
@@ -0,0 +1,28 @@
+=head1 NAME
+
+Jifty::Manual::Style - Jifty coding style guide
+
+=head3 Private documentation
+
+When documenting a private method, or providing documentation which is
+not useful to the user of the module (and is presumably useful to the
+developer), wrap it in =begin/end private. This way it does not show
+up in perldoc where a user would see it and yet is still available and
+well formatted (that is, not just a lump comment) when looking at the
+code.
+
+ =begin private
+
+ =head2 import_extra
+
+ Called by L<Test::More>'s C<import> code when L<Jifty::Test> is first
+ C<use>'d, it calls L</setup>, and asks Test::More to export its
+ symbols to the namespace that C<use>'d this one.
+
+ =end private
+
+ sub import_extra {
+ ...
+ }
+
+=cut
More information about the Jifty-commit
mailing list