Skip to content

Commit

Permalink
Doc linting fixes
Browse files Browse the repository at this point in the history
Signed-off-by: George Steel <[email protected]>
  • Loading branch information
gsteel committed Oct 24, 2024
1 parent d805dcf commit 29146de
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 27 deletions.
1 change: 0 additions & 1 deletion docs/book/index.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/book/index.md
8 changes: 4 additions & 4 deletions docs/book/v1/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,10 +298,10 @@ and an error condition (or `null` for no error). It returns a response.
`FinalHandler` allows two optional arguments during instantiation

- `$options`, an array of options with which to configure itself. These options currently include:
- `env`, the application environment. If set to "production", no stack traces will be provided.
- `onerror`, a callable to execute if an error is passed when `FinalHandler` is invoked. The
callable is invoked with the error (which will be `null` in the absence of an error), the request,
and the response, in that order.
- `env`, the application environment. If set to "production", no stack traces will be provided.
- `onerror`, a callable to execute if an error is passed when `FinalHandler` is invoked. The
callable is invoked with the error (which will be `null` in the absence of an error), the request,
and the response, in that order.
- `Psr\Http\Message\ResponseInterface $response`; if passed, it will compare the response passed
during invocation against this instance; if they are different, it will return the response from
the invocation, as this indicates that one or more middleware provided a new response instance.
Expand Down
6 changes: 3 additions & 3 deletions docs/book/v1/error-handlers.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ layer). It does the following:
- Creates a PHP error handler that catches any errors in the `error_handling()`
mask and throws them as `ErrorException` instances.
- Wraps the invocation of the delegate in a try/catch block:
- if no exception is caught, and the result is a response, it returns it.
- if no exception is caught, it raises an exception, which will be caught.
- any caught exception is transformed into an error response.
- if no exception is caught, and the result is a response, it returns it.
- if no exception is caught, it raises an exception, which will be caught.
- any caught exception is transformed into an error response.
To generate the error response, we provide the ability to inject a callable with
the following signature into the `ErrorHandler` during instantiation:
Expand Down
6 changes: 3 additions & 3 deletions docs/book/v2/error-handlers.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ layer). It does the following:
- Creates a PHP error handler that catches any errors in the `error_handling()`
mask and throws them as `ErrorException` instances.
- Wraps the invocation of the delegate in a try/catch block:
- if no exception is caught, and the result is a response, it returns it.
- if no exception is caught, it raises an exception, which will be caught.
- any caught exception is transformed into an error response.
- if no exception is caught, and the result is a response, it returns it.
- if no exception is caught, it raises an exception, which will be caught.
- any caught exception is transformed into an error response.

To generate the error response, we provide the ability to inject a callable with
the following signature into the `ErrorHandler` during instantiation:
Expand Down
18 changes: 9 additions & 9 deletions docs/book/v2/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ recommend the following:
- Pipe `Laminas\Stratigility\Middleware\OriginalMessages` as the outermost layer of
your application. This will inject the following request attributes into
layers beneath it:
- `originalRequest`, mapping to the request provided to it at invocation.
- `originalResponse`, mapping to the response provided to it at invocation.
- `originalUri`, mapping to the URI composed by the request provided to it at
invocation.
- `originalRequest`, mapping to the request provided to it at invocation.
- `originalResponse`, mapping to the response provided to it at invocation.
- `originalUri`, mapping to the URI composed by the request provided to it at
invocation.

You can then access these values within other middleware:

Expand Down Expand Up @@ -594,11 +594,11 @@ The following classes, methods, and arguments are deprecated starting in version
The following signature changes were made with the 2.0.0 release:

- `Laminas\Stratigility\Next`:
- The `$done` constructor argument was renamed to `$nextDelegate`, and now
allows either `callable` or `Interop\Http\ServerMiddleware\DelegateInterface`
arguments.
- The `$response` argument to `__invoke()` was removed.
- The (optional) `$err` argument to `__invoke()` was removed.
- The `$done` constructor argument was renamed to `$nextDelegate`, and now
allows either `callable` or `Interop\Http\ServerMiddleware\DelegateInterface`
arguments.
- The `$response` argument to `__invoke()` was removed.
- The (optional) `$err` argument to `__invoke()` was removed.

## Removed functionality

Expand Down
6 changes: 3 additions & 3 deletions docs/book/v3/error-handlers.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ layer). It does the following:
- Creates a PHP error handler that catches any errors in the `error_handling()`
mask and throws them as `ErrorException` instances.
- Wraps the invocation of the delegate in a try/catch block:
- if no exception is caught, and the result is a response, it returns it.
- if no exception is caught, it raises an exception, which will be caught.
- any caught exception is transformed into an error response.
- if no exception is caught, and the result is a response, it returns it.
- if no exception is caught, it raises an exception, which will be caught.
- any caught exception is transformed into an error response.

To generate the error response, we provide the ability to inject a callable with
the following signature into the `ErrorHandler` during instantiation:
Expand Down
10 changes: 5 additions & 5 deletions docs/book/v3/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ and provide guidance on how to upgrade your application to be compatible.
- [PSR-15](#psr-15)
- [Pipeline (`MiddlewarePipe`)](#pipeline-middlewarepipe)
- [Changes in public interfaces](#changes-in-public-interfaces)
- [Signature changes](#signature-changes)
- [Class additions](#class-additions)
- [Removed classes and exceptions](#removed-classes-and-exceptions)
- [Removed methods](#removed-methods)
- [Function additions](#function-additions)
- [Signature changes](#signature-changes)
- [Class additions](#class-additions)
- [Removed classes and exceptions](#removed-classes-and-exceptions)
- [Removed methods](#removed-methods)
- [Function additions](#function-additions)
<!-- markdownlint-enable link-fragments -->

## PHP support
Expand Down

0 comments on commit 29146de

Please sign in to comment.