Doc fixes

kentnl · Aug 7, 2014 · 029ae22 · 029ae22
1 parent 4bd2cc0
commit 029ae22
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 4 deletions.
diff --git a/README.mkdn b/README.mkdn
@@ -111,7 +111,7 @@ Reset the walk routine back to the state it was before you walked.
 ## step
 
 Increments one step forward in the git history, and dispatches the object to the
-OnCommit handlers.
+`OnCommit` handlers.
 
 If there are more possible steps to take, it will return a true value.
 

diff --git a/lib/Git/PurePerl/Walker.pm b/lib/Git/PurePerl/Walker.pm
@@ -278,7 +278,7 @@ sub reset {
 =method step
 
 Increments one step forward in the git history, and dispatches the object to the
-OnCommit handlers.
+C<OnCommit> handlers.
 
 If there are more possible steps to take, it will return a true value.
 

diff --git a/lib/Git/PurePerl/Walker/Role/HasRepo.pm b/lib/Git/PurePerl/Walker/Role/HasRepo.pm
@@ -64,7 +64,7 @@ has '_repo' => ( isa => GPPW_Repository, is => 'rw', weak_ref => 1 );
 Construct an entity for a given repository.
 
 This internally calls L<< C<MooseX::B<Clone>>|MooseX::Clone >> on the current object, passing the _repo
-field to its constructor, producing a seperate, disconnected object to work
+field to its constructor, producing a separate, disconnected object to work
 with.
 
 The rationale behind this is simple: Its very likely users will want one set of
@@ -73,7 +73,7 @@ multiple repositories.
 
 And as each repository will need to maintain its own state for traversal, they
 have to normally manually construct an object for each repository, manually
-disconnecting the constructor arugments.
+disconnecting the constructor arguments.
 
 This instead is simple:
 

diff --git a/maint/perlcritic.rc.gen.pl b/maint/perlcritic.rc.gen.pl
@@ -20,6 +20,7 @@
 
 my @stopwords = (
   qw(
+    repo OnCommit args namespace
     )
 );
 for my $wordlist (@stopwords) {

diff --git a/misc/perlcritic.deps b/misc/perlcritic.deps
@@ -1,3 +1,4 @@
+Perl::Critic::Policy::Documentation::PodSpelling~0
 Perl::Critic::Policy::Lax::RequireExplicitPackage::ExceptForPragmata~0
 Perl::Critic::Policy::Variables::ProhibitUnusedVarsStricter~0
 Perl::Critic::ProfileCompiler::Bundle::Bangs~0

diff --git a/perlcritic.rc b/perlcritic.rc
@@ -124,6 +124,7 @@ allow_includes = 1
 
 [Documentation::PodSpelling]
 spell_command = aspell list --lang en_US
+stop_words = repo OnCommit args namespace
 
 [Documentation::ProhibitAdjacentLinks]
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,6 +20,7 @@ @@
     my @stopwords = (
       qw(
+        repo OnCommit args namespace
         )
     );
     for my $wordlist (@stopwords) {
@@ Expand Down @@