From c685ef59d8cce83e30bb47bf4b2b931b89a867e7 Mon Sep 17 00:00:00 2001 From: George Steel Date: Tue, 6 Feb 2024 16:46:31 +0000 Subject: [PATCH] Minor linting fixes for the docs Signed-off-by: George Steel --- docs/book/v1/api.md | 2 +- docs/book/v1/executing-middleware.md | 4 ++-- docs/book/v1/middleware.md | 2 +- docs/book/v2/executing-middleware.md | 2 +- docs/book/v2/middleware.md | 2 +- docs/book/v2/migration.md | 2 +- docs/book/v3/executing-middleware.md | 2 +- docs/book/v3/middleware.md | 2 +- docs/book/v3/migration.md | 2 ++ docs/book/v3/usage.md | 2 +- 10 files changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/book/v1/api.md b/docs/book/v1/api.md index 89023381..24f85ce2 100644 --- a/docs/book/v1/api.md +++ b/docs/book/v1/api.md @@ -421,7 +421,7 @@ Two versions exist: You can manually decorate callable middleware using these decorators, or simply let `MiddlewarePipe` do the work for you. To let `MiddlewarePipe` handle this, -however, you _must_ compose a response prototype prior to piping middleware +however, you *must* compose a response prototype prior to piping middleware using the legacy middleware signature. ## Delegates diff --git a/docs/book/v1/executing-middleware.md b/docs/book/v1/executing-middleware.md index 3d66b2ca..01c041fc 100644 --- a/docs/book/v1/executing-middleware.md +++ b/docs/book/v1/executing-middleware.md @@ -13,8 +13,8 @@ $app = new MiddlewarePipe(); // Middleware representing the application $app->pipe('/api', $api); // API middleware attached to the path "/api" ``` - -> ### Request path changes when path matched + +> ## Request path changes when path matched > > When you pipe middleware using a path (other than '' or '/'), the middleware > is dispatched with a request that strips the matched segment(s) from the start diff --git a/docs/book/v1/middleware.md b/docs/book/v1/middleware.md index 2009c824..94921291 100644 --- a/docs/book/v1/middleware.md +++ b/docs/book/v1/middleware.md @@ -44,7 +44,7 @@ this point, a "final handler" is composed by default to report 404 status. So, concisely put, _middleware are PHP callables that accept a request and response object, and do something with it_. - + > ### http-interop middleware > > The above example demonstrates the legacy (pre-1.3.0) signature for diff --git a/docs/book/v2/executing-middleware.md b/docs/book/v2/executing-middleware.md index a3d17924..c8b370f9 100644 --- a/docs/book/v2/executing-middleware.md +++ b/docs/book/v2/executing-middleware.md @@ -13,7 +13,7 @@ $app = new MiddlewarePipe(); // Middleware representing the application $app->pipe('/api', $api); // API middleware attached to the path "/api" ``` - + > ### Request path changes when path matched > > When you pipe middleware using a path (other than '' or '/'), the middleware diff --git a/docs/book/v2/middleware.md b/docs/book/v2/middleware.md index b47971a1..ecf787b7 100644 --- a/docs/book/v2/middleware.md +++ b/docs/book/v2/middleware.md @@ -56,7 +56,7 @@ this point, a "final handler" is composed by default to report 404 status. So, concisely put, _middleware are PHP callables that accept a request object, and do something with it_. - + > ### http-interop middleware > > The above example demonstrates the using the interfaces from the http-interop diff --git a/docs/book/v2/migration.md b/docs/book/v2/migration.md index d77801d1..4f48e2d6 100644 --- a/docs/book/v2/migration.md +++ b/docs/book/v2/migration.md @@ -454,7 +454,7 @@ class PingMiddleware implements ServerMiddlewareInterface > ### Implementing http-interop between Stratigility 1.3 and 2.0 > -> While you _can_ write your middleware to implement the +> While you *can* write your middleware to implement the > http-interop/http-middleware middleware interface, please be aware that if you > do so, you will need to take additional steps when upgrading from 1.3 to 2.0. > diff --git a/docs/book/v3/executing-middleware.md b/docs/book/v3/executing-middleware.md index 423f477b..d8719174 100644 --- a/docs/book/v3/executing-middleware.md +++ b/docs/book/v3/executing-middleware.md @@ -13,7 +13,7 @@ $app = new MiddlewarePipe(); // Middleware representing the application $app->pipe(new PathMiddlewareDecorator('/api', $api)); // API middleware attached to the path "/api" ``` - + > ### Request path changes when path matched > > When you use the `PathMiddlewareDecorator` using a path (other than '' or diff --git a/docs/book/v3/middleware.md b/docs/book/v3/middleware.md index a7ad081d..e62ba9d2 100644 --- a/docs/book/v3/middleware.md +++ b/docs/book/v3/middleware.md @@ -6,7 +6,7 @@ Middleware is code that exists between the request and response, and which can take the incoming request, perform actions based on it, and either complete the response or pass delegation on to the next middleware in the queue. - + > ### Installation requirements > > The following example depends on the [laminas-httphandlerrunner](http://docs.laminas.dev/laminas-httphandlerrunner) diff --git a/docs/book/v3/migration.md b/docs/book/v3/migration.md index 2fd9c162..667fea9a 100644 --- a/docs/book/v3/migration.md +++ b/docs/book/v3/migration.md @@ -3,6 +3,7 @@ In this document, we outline the backwards breaking changes with version 3.0, and provide guidance on how to upgrade your application to be compatible. + - [PHP support](#php-support) - [PSR-15](#psr-15) - [Pipeline (`MiddlewarePipe`)](#pipeline-middlewarepipe) @@ -12,6 +13,7 @@ and provide guidance on how to upgrade your application to be compatible. - [Removed classes and exceptions](#removed-classes-and-exceptions) - [Removed methods](#removed-methods) - [Function additions](#function-additions) + ## PHP support diff --git a/docs/book/v3/usage.md b/docs/book/v3/usage.md index 0c33bff9..a6775dc0 100644 --- a/docs/book/v3/usage.md +++ b/docs/book/v3/usage.md @@ -1,6 +1,6 @@ # Usage - + > ### Installation requirements > > The following example depends on the [laminas-httphandlerrunner](http://docs.laminas.dev/laminas-httphandlerrunner)