RE: moose and pod

I add another level under the attributes and methods to differentiate public and private.
I also add another section in there for Roles.

In my Roles, I make sure if there are required methods, that I document what the expected api is supposed to be.

=head2 REQUIRES
   
=cut

requires  qw(method1);

=head3 method1(%args)

Returns ...

  Arg 0: self
  Arg 1: args hash ...

=cut

-----Original Message-----
From: Maurice Mengel [mailto:[email protected]] 
Sent: Tuesday, December 18, 2012 10:38 AM
To: [email protected]
Subject: moose and pod

Hi!

I am new to the list and also still new to Moose. I wonder how exactly to document my Moose classes. I am sure you discussed this before, but I couldn't find much on the list archive. Perhaps it's time to add something on this matter to the documentation. Perhaps in Best Practices. Or elsewhere in Manual. Perhaps I am also missing something. Please point me in the right direction if I do.

I guess there are some things that seem fairly clear and other things where we might have different opinions. It seems some people like inherited stuff (including roles) to be listed in each class that inherits stuff and others like it only in the class which defines stuff. That shouldn't stop us. We could make suggestions for both solutions. This is perl after all.

The first two sections seem pretty much standard. How should I refer to inherited attributes and methods?

=head1 Attributes

=head1 Methods

=head1 Inherited Stuff [;-)]

Thanks!