qa: edits to documentation

- Use consistent bullet point formatting.
- Use consistent line lengths.
- Use consistent casing.
- Use consistent whitespace.
- Minor grammatical changes and linking.

Author: weierophinney

CHANGELOG.md

@@ -8,8 +8,7 @@ Versions 0.3.0 and prior were released as "weierophinney/problem-details".
 
 ### Added
 
-- [#51](https://github.com/zendframework/zend-problem-details/pull/51) adds new `problem-details.default_types_map`
-  config option, that can be used to define custom `type` values based on status codes.
+- [#51](https://github.com/zendframework/zend-problem-details/pull/51) adds a new `problem-details.default_types_map` config option, which can be used to define custom `type` values based on status codes.
 
 ### Changed
 

docs/book/default-types.md

@@ -1,46 +1,50 @@
-# Default types
+# Default Types
 
-When you raise your own exceptions implementing `Zend\ProblemDetails\Exception\ProblemDetailsExceptionInterface` you
-will always be in control of all the properties returned as part of the response payload, naming `status`, `type`,
-`title`, `detail`, etc.
+When you raise your own exceptions implementing `Zend\ProblemDetails\Exception\ProblemDetailsExceptionInterface` 
+you will always be in control of all the properties returned as part of the
+response payload, including the `status`, `type`, `title`, `detail`, etc.
+items.
 
-However, there are some use cases in which this library will have to infer some of those values.
+However, there are some use cases in which this library will have to infer some
+of those values.
 
 The main situations in which this can happen are:
 
-* When an exception not implementing `ProblemDetailsExceptionInterface` is captured by the `ProblemDetailsMiddleware`.
-* When the `ProblemDetailsNotFoundHandler` is executed.
+- When an exception not implementing `ProblemDetailsExceptionInterface` is
+  captured by the `ProblemDetailsMiddleware`.
+- When the `ProblemDetailsNotFoundHandler` is executed.
 
-In these two cases, the `title` and `type` properties will be inferred from the status code, which will usually be
-`500` in the first case and `404` in the second one.
+In these two cases, the `title` and `type` properties will be inferred from the
+status code, which will usually be `500` in the first case and `404` in the
+second one.
 
-> To be more precise, the `ProblemDetailsMiddleware` will use the exception's error code when `debug` is `true`,
-> and `500` otherwise.
+> To be more precise, the `ProblemDetailsMiddleware` will use the exception's
+> error code when `debug` is `true`, and `500` otherwise.
 
-Because of this, in any of those cases, you will end up with values like `https://httpstatus.es/404` or
-`https://httpstatus.es/500` for the `type` property.
+Because of this, in any of those cases, you will end up with values like
+`https://httpstatus.es/404` or `https://httpstatus.es/500` for the `type`
+property.
 
 ## Configuring custom default types
 
-Since the `type` property will usually be used by API consumers to uniquely identify an error, you might want to be
-able to provide your own custom values for the `type` property.
+Since the `type` property will usually be used by API consumers to uniquely
+identify an error, you might want to be able to provide your own custom values
+for the `type` property.
 
-In order to do that, this library lets you configure the default `type` value to be used for every status code
-when some of the cases listed above happens.
+In order to do that, this library lets you configure the default `type` value to
+be used for every status code when some of the cases listed above happens.
 
 ```php
 return [
-
     'problem-details' => [
         'default_types_map' => [
             404 => 'https://example.com/problem-details/error/not-found',
             500 => 'https://example.com/problem-details/error/internal-server-error',
         ],
     ],
-
 ];
 ```
 
 If this configuration is found, it will be consumed by the
-[ProblemDetailsResponseFactoryFactory](response.md#problemdetailsresponsefactoryfactory) and your custom values will
-be used when the `type` was not explicitly provided.
+[ProblemDetailsResponseFactoryFactory](response.md#problemdetailsresponsefactoryfactory)
+and your custom values will be used when the `type` was not explicitly provided.

docs/book/response.md

@@ -147,9 +147,10 @@ This package also provides a factory for generating the
       containing a `json_flags` key, and that value is an integer, that value is
       provided as the `$jsonFlags` parameter.
     - If the service contains a `problem-details` key with an array value
-      containing a `default_types_map` key, and that value is an array, that value is
-      provided as the `$defaultTypesMap` parameter.
-      > More information about defining [default types](default-types.md).
+      containing a `default_types_map` key, and that value is an array, that
+      value is provided as the `$defaultTypesMap` parameter; see the
+      [default types documentation](default-types.md) for details on defining
+      this map.
 
 If any of the above config values are not present, a `null` value will be
 passed, allowing the default value to be used.

mkdocs.yml

@@ -9,7 +9,7 @@ pages:
         - "Exceptions": exception.md
         - "Error Handling Middleware": middleware.md
         - "Not Found Handler": not-found-handler.md
-        - "Default types": default-types.md
+        - "Default Types": default-types.md
 site_name: zend-problem-details
 site_description: 'PSR-7 Problem Details for HTTP API responses and middleware'
 repo_url: 'https://github.com/zendframework/zend-problem-details'