Fix spelling, grammar and structural errors in POD
Dagfinn Ilmari Mannsåker [Mon, 5 May 2014 18:44:41 +0000 (19:44 +0100)]
- Consistently use imperative tense in Delta headers
- Fix header levels in Delta
- Consistently spell "backwards compatibility" out
- Add new and remove bogus stopwords
- Fix a handful of typos

lib/Catalyst.pm
lib/Catalyst/Delta.pod
lib/Catalyst/Utils.pm
t/author/spelling.t

index fbc036a..48f4949 100755 (executable)
@@ -3587,7 +3587,7 @@ example given above, which uses L<JSON::Maybe> to provide either L<JSON::PP>
 it installed (if you want the faster XS parser, add it to you project Makefile.PL
 or dist.ini, cpanfile, etc.)
 
-The C<data_handlers> configuation is a hashref whose keys are HTTP Content-Types
+The C<data_handlers> configuration is a hashref whose keys are HTTP Content-Types
 (matched against the incoming request type using a regexp such as to be case
 insensitive) and whose values are coderefs that receive a localized version of
 C<$_> which is a filehandle object pointing to received body.
index f98d843..398649f 100755 (executable)
@@ -9,7 +9,7 @@ Catalyst releases.
 
 =head2 VERSION 5.90060+
 
-=head3 Deprecation of Catalyst::Utils::ensure_class_loaded
+=head3 Deprecate Catalyst::Utils::ensure_class_loaded
 
 Going forward we recommend you use L<Module::Runtime>.  In fact we will
 be converting all uses of L<Class::Load> to L<Module::Runtime>.  We will
@@ -26,7 +26,7 @@ always use the streaming interface for the cases when the body is a
 simple scalar, object or filehandle like.  In those cases we now just
 pass the simple response on to the plack handler.  This might lead to
 some minor differences in how streaming is handled.  For example, you
-might notice that streaming starts properly supportubg chunked encoding when
+might notice that streaming starts properly supporting chunked encoding when
 on a server that supports that, or that previously missing headers
 (possible content-length) might appear suddenly correct.  Also, if you
 are using middleware like L<Plack::Middleware::XSendfile> and are using
@@ -45,7 +45,7 @@ using one server but deploying using a different one, differences in
 what those server do with streaming should be noted.
 
 Please see note below about changes to filehandle support and existing
-Plack middleware to aid in back compatibility.
+Plack middleware to aid in backwards compatibility.
 
 =head3 Distinguish between body null versus undef.
 
@@ -68,7 +68,7 @@ so we benefit from better collaboration with developers outside Catalyst, 3)
 In the future you'll be able to change or trim the middleware stack to get
 additional performance when you don't need all the checks and constraints.
 
-=head3 Deprecation of Filehandle like objects that do read but not getline
+=head3 Deprecate Filehandle like objects that do read but not getline
 
 We also deprecated setting the response body to an object that does 'read'
 but not 'getline'.  If you are using a custom IO-Handle like object for
@@ -79,31 +79,31 @@ will issue a warning.  You also may run into this issue with L<MogileFS::Client>
 which does read but not getline.  For now we will just warn when encountering
 such an object and fallback to the previous behavior (where L<Catalyst::Engine>
 itself unrolls the filehandle and performs blocking streams).  However
-this backcompat will be removed in an upcoming release so you should either
+this backwards compatibility will be removed in an upcoming release so you should either
 rewrite your custom filehandle objects to support getline or start using the 
 middleware that adapts read for getline L<Plack::Middleware::AdaptFilehandleRead>.
 
-=head3 Response->headers become readonly after finalizing
+=head3 Response->headers become read-only after finalizing
 
 Once the response headers are finalized, trying to change them is not allowed
 (in the past you could change them and this would lead to unexpected results).
 
-=head3 Offically deprecation of L<Catalyst::Engine::PSGI>
+=head3 Officially deprecate L<Catalyst::Engine::PSGI>
 
 L<Catalyst::Engine::PSGI> is also officially no longer supported.  We will
-no long run test cases against this and can remove backcompat code for it
-as deemed necessary for the evolution of the platform.  You should simple
-discontinue use of this engine, as L<Catalyst> has been PSGI at the core
-for several years.
+no long run test cases against this and can remove backwards compatibility code for it
+as deemed necessary for the evolution of the platform.  You should simply
+discontinue use of this engine, as L<Catalyst> has been PSGI at the core for
+several years.
 
-=head2 Officially deprecate finding the PSGI $env anyplace other than Request
+=head3 Officially deprecate finding the PSGI $env anyplace other than Request
 
 A few early releases of Cataplack had the PSGI $env in L<Catalyst::Engine>.
-Code has been maintained here for backcompat reasons.  This is no longer
-supported and will be removed in upcoming release, so you should update
+Code has been maintained here for backwards compatibility reasons.  This is no
+longer supported and will be removed in upcoming release, so you should update
 your code and / or upgrade to a newer version of L<Catalyst>
 
-=head2 Deprecate setting Response->body after using write/write_fh
+=head3 Deprecate setting Response->body after using write/write_fh
 
 Setting $c->res->body to a filehandle after using $c->res->write or
 $c->res->write_fh is no longer considered allowed, since we can't send
@@ -241,7 +241,7 @@ Below is a brief list of features which have been deprecated in this release:
 
 =item MyApp->plugin method is deprecated, use L<Catalyst::Model::Adaptor> instead.
 
-=item __PACKAGE__->mk_accessors() is supported for backward compatibility only, use Moose attributes instead in new code.
+=item __PACKAGE__->mk_accessors() is supported for backwards compatibility only, use Moose attributes instead in new code.
 
 =item Use of Catalyst::Base now warns
 
index a02b762..78c293a 100644 (file)
@@ -512,7 +512,7 @@ Localize C<$env> under the current controller path prefix:
       my $env = $c->Catalyst::Utils::env_at_path_prefix;
     }
 
-Assuming you have a requst like GET /user/name:
+Assuming you have a request like GET /user/name:
 
 In the example case C<$env> will have PATH_INFO of '/name' instead of
 '/user/name' and SCRIPT_NAME will now be '/user'.
@@ -555,7 +555,7 @@ Assuming you have a request like GET /user/name:
 In the example case C<$env> will have PATH_INFO of '/' instead of
 '/user/name' and SCRIPT_NAME will now be '/user/name'.
 
-Alternatively, assuming you have a requst like GET /user/name/foo:
+Alternatively, assuming you have a request like GET /user/name/foo:
 
 In this example case C<$env> will have PATH_INFO of '/foo' instead of
 '/user/name/foo' and SCRIPT_NAME will now be '/user/name'.
@@ -600,7 +600,7 @@ Localize C<$env> under the current request URI:
       my $env = $c->Catalyst::Utils::env_at_request_uri
     }
 
-Assuming you have a requst like GET /user/name/hello:
+Assuming you have a request like GET /user/name/hello:
 
 In the example case C<$env> will have PATH_INFO of '/' instead of
 '/user/name' and SCRIPT_NAME will now be '/user/name/hello'.
index e98de80..1319a87 100644 (file)
@@ -20,8 +20,9 @@ add_stopwords(qw(
     FastCGI Stringifies Rethrows DispatchType Wishlist Refactor ROADMAP HTTPS Unescapes Restarter Nginx Refactored
     ActionClass LocalRegex LocalRegexp MyAction metadata cometd io psgix websockets
     UTF async codebase dev filenames params MyMiddleware
-    JSON POSTed RESTful configuation performant subref actionrole
+    JSON POSTed RESTful performant subref actionrole
     chunked chunking codewise distingush equivilent plack Javascript
+    ConfigLoader getline
     Andreas
     Ashton
     Axel
@@ -79,6 +80,7 @@ add_stopwords(qw(
     Szilakszi
     Tatsuhiko
     Ulf
+    Upasana
     Vilain
     Viljo
     Wardley