Merge remote branch 'zts/pod-cleanup' into release
Tomas Doran [Wed, 9 Dec 2009 01:30:24 +0000 (01:30 +0000)]
* zts/pod-cleanup:
  Added some more POD for the ::Git::Object classes.
  Remove unneeded =cut commands, and various other cleanups.

1  2 
lib/Gitalist/Git/Repo.pm

diff --combined lib/Gitalist/Git/Repo.pm
@@@ -23,8 -23,6 +23,8 @@@ class Gitalist::Git::Repo 
      ## Public methods
      method project (NonEmptySimpleStr $project) {
          my $path = $self->repo_dir->subdir($project)->resolve;
 +        $self->repo_dir->resolve; # FIXME - This needs to be called, or if repo_dir contains .., it'll explode below!
 +                                  #         This is a Path::Class::Dir bug, right?
          die "Directory traversal prohibited" unless $self->repo_dir->contains($path);
          die "Not a valid Project" unless $self->_is_git_repo($path);
          return Project->new( $self->repo_dir->subdir($project) );
@@@ -74,37 -72,32 +74,32 @@@ This class models a Gitalist Repo, whic
  Projects (git repositories).  It is used for creating Project
  objects to work with.
  
  
  =head1 ATTRIBUTES
  
- =head2 repo_dir
- L<Path::Class::Dir> for the root of the Repo.
+ =head2 repo_dir (C<Path::Class::Dir>)
  
- =cut
+ The filesystem root of the Repo.
  
  =head2 projects
  
- An array of L<Gitalist::Git::Project> for each valid git repo
- found in repo_dir.
+ An array of all Repos found in C<repo_dir>.
  
- =cut
  
  
  =head1 METHODS
  
- =head2 project (NonEmptySimpleStr $project)
+ =head2 project (Str $project)
  
  Returns a L<Gitalist::Git::Project> for the specified project
  name.
  
- =cut
  
  =head1 SEE ALSO
  
  L<Gitalist::Git::Project>
  
  =head1 AUTHORS
  
  See L<Gitalist> for authors.