Skip to content

Commit de0cc80

Browse files
Fix link formatting (#10310)
1 parent 1660ca3 commit de0cc80

19 files changed

+50
-50
lines changed

Diff for: billing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2446,7 +2446,7 @@ Route::get('/product-checkout', function (Request $request) {
24462446
});
24472447
```
24482448

2449-
After a guest checkout has been completed, Stripe can dispatch a `checkout.session.completed` webhook event, so make sure to [configure your Stripe webhook](https://dashboard.stripe.com/webhooks) to actually send this event to your application. Once the webhook has been enabled within the Stripe dashboard, you may [handle the webhook with Cashier](#handling-stripe-webhooks). The object contained in the webhook payload will be a [`checkout` object](https://stripe.com/docs/api/checkout/sessions/object) that you may inspect in order to fulfill your customer's order.
2449+
After a guest checkout has been completed, Stripe can dispatch a `checkout.session.completed` webhook event, so make sure to [configure your Stripe webhook](https://dashboard.stripe.com/webhooks) to actually send this event to your application. Once the webhook has been enabled within the Stripe dashboard, you may [handle the webhook with Cashier](#handling-stripe-webhooks). The object contained in the webhook payload will be a [checkout object](https://stripe.com/docs/api/checkout/sessions/object) that you may inspect in order to fulfill your customer's order.
24502450

24512451
<a name="handling-failed-payments"></a>
24522452
## Handling Failed Payments

Diff for: blade.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1062,7 +1062,7 @@ If you need to merge other attributes onto your component, you can chain the `me
10621062
```
10631063

10641064
> [!NOTE]
1065-
> If you need to conditionally compile classes on other HTML elements that shouldn't receive merged attributes, you can use the [`@class` directive](#conditional-classes).
1065+
> If you need to conditionally compile classes on other HTML elements that shouldn't receive merged attributes, you can use the [@class directive](#conditional-classes).
10661066
10671067
<a name="non-class-attribute-merging"></a>
10681068
#### Non-Class Attribute Merging
@@ -1926,7 +1926,7 @@ As you can see, we will chain the `format` method onto whatever expression is pa
19261926
<a name="custom-echo-handlers"></a>
19271927
### Custom Echo Handlers
19281928

1929-
If you attempt to "echo" an object using Blade, the object's `__toString` method will be invoked. The [`__toString`](https://www.php.net/manual/en/language.oop5.magic.php#object.tostring) method is one of PHP's built-in "magic methods". However, sometimes you may not have control over the `__toString` method of a given class, such as when the class that you are interacting with belongs to a third-party library.
1929+
If you attempt to "echo" an object using Blade, the object's `__toString` method will be invoked. The [__toString](https://www.php.net/manual/en/language.oop5.magic.php#object.tostring) method is one of PHP's built-in "magic methods". However, sometimes you may not have control over the `__toString` method of a given class, such as when the class that you are interacting with belongs to a third-party library.
19301930

19311931
In these cases, Blade allows you to register a custom echo handler for that particular type of object. To accomplish this, you should invoke Blade's `stringable` method. The `stringable` method accepts a closure. This closure should type-hint the type of object that it is responsible for rendering. Typically, the `stringable` method should be invoked within the `boot` method of your application's `AppServiceProvider` class:
19321932

Diff for: container.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ class PhotoController extends Controller
291291
}
292292
```
293293

294-
In addition to the `Storage` attribute, Laravel offers `Auth`, `Cache`, `Config`, `DB`, `Log`, `RouteParameter`, and [`Tag`](#tagging) attributes:
294+
In addition to the `Storage` attribute, Laravel offers `Auth`, `Cache`, `Config`, `DB`, `Log`, `RouteParameter`, and [Tag](#tagging) attributes:
295295

296296
```php
297297
<?php

Diff for: eloquent.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,7 @@ Flight::where(function ($query) {
531531
<a name="chunking-using-lazy-collections"></a>
532532
### Chunking Using Lazy Collections
533533

534-
The `lazy` method works similarly to [the `chunk` method](#chunking-results) in the sense that, behind the scenes, it executes the query in chunks. However, instead of passing each chunk directly into a callback as is, the `lazy` method returns a flattened [`LazyCollection`](/docs/{{version}}/collections#lazy-collections) of Eloquent models, which lets you interact with the results as a single stream:
534+
The `lazy` method works similarly to [the `chunk` method](#chunking-results) in the sense that, behind the scenes, it executes the query in chunks. However, instead of passing each chunk directly into a callback as is, the `lazy` method returns a flattened [LazyCollection](/docs/{{version}}/collections#lazy-collections) of Eloquent models, which lets you interact with the results as a single stream:
535535

536536
```php
537537
use App\Models\Flight;

Diff for: hashing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Bcrypt is a great choice for hashing passwords because its "work factor" is adju
1818
<a name="configuration"></a>
1919
## Configuration
2020

21-
By default, Laravel uses the `bcrypt` hashing driver when hashing data. However, several other hashing drivers are supported, including [`argon`](https://en.wikipedia.org/wiki/Argon2) and [`argon2id`](https://en.wikipedia.org/wiki/Argon2).
21+
By default, Laravel uses the `bcrypt` hashing driver when hashing data. However, several other hashing drivers are supported, including [argon](https://en.wikipedia.org/wiki/Argon2) and [argon2id](https://en.wikipedia.org/wiki/Argon2).
2222

2323
You may specify your application's hashing driver using the `HASH_DRIVER` environment variable. But, if you want to customize all of Laravel's hashing driver options, you should publish the complete `hashing` configuration file using the `config:publish` Artisan command:
2424

Diff for: helpers.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2051,7 +2051,7 @@ blank(false);
20512051
// false
20522052
```
20532053

2054-
For the inverse of `blank`, see the [`filled`](#method-filled) method.
2054+
For the inverse of `blank`, see the [filled](#method-filled) method.
20552055

20562056
<a name="method-broadcast"></a>
20572057
#### `broadcast()` {.collection-method}
@@ -2184,7 +2184,7 @@ dd($value);
21842184
dd($value1, $value2, $value3, ...);
21852185
```
21862186

2187-
If you do not want to halt the execution of your script, use the [`dump`](#method-dump) function instead.
2187+
If you do not want to halt the execution of your script, use the [dump](#method-dump) function instead.
21882188

21892189
<a name="method-dispatch"></a>
21902190
#### `dispatch()` {.collection-method}
@@ -2215,7 +2215,7 @@ dump($value);
22152215
dump($value1, $value2, $value3, ...);
22162216
```
22172217

2218-
If you want to stop executing the script after dumping the variables, use the [`dd`](#method-dd) function instead.
2218+
If you want to stop executing the script after dumping the variables, use the [dd](#method-dd) function instead.
22192219

22202220
<a name="method-encrypt"></a>
22212221
#### `encrypt()` {.collection-method}
@@ -2292,7 +2292,7 @@ filled(collect());
22922292
// false
22932293
```
22942294

2295-
For the inverse of `filled`, see the [`blank`](#method-blank) method.
2295+
For the inverse of `filled`, see the [blank](#method-blank) method.
22962296

22972297
<a name="method-info"></a>
22982298
#### `info()` {.collection-method}
@@ -3241,7 +3241,7 @@ Sleep::for(1)->second();
32413241
$start->diffForHumans(); // 1 second ago
32423242
```
32433243

3244-
Laravel uses the `Sleep` class internally whenever it is pausing execution. For example, the [`retry`](#method-retry) helper uses the `Sleep` class when sleeping, allowing for improved testability when using that helper.
3244+
Laravel uses the `Sleep` class internally whenever it is pausing execution. For example, the [retry](#method-retry) helper uses the `Sleep` class when sleeping, allowing for improved testability when using that helper.
32453245

32463246
<a name="timebox"></a>
32473247
### Timebox

Diff for: homestead.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -692,7 +692,7 @@ Supported `policy` values include: `none`, `download`, `upload`, and `public`.
692692
<a name="laravel-dusk"></a>
693693
### Laravel Dusk
694694

695-
In order to run [Laravel Dusk](/docs/{{version}}/dusk) tests within Homestead, you should enable the [`webdriver` feature](#installing-optional-features) in your Homestead configuration:
695+
In order to run [Laravel Dusk](/docs/{{version}}/dusk) tests within Homestead, you should enable the [webdriver feature](#installing-optional-features) in your Homestead configuration:
696696

697697
```yaml
698698
features:

Diff for: mail.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ To utilize AWS [temporary credentials](https://docs.aws.amazon.com/IAM/latest/Us
176176
],
177177
```
178178

179-
To interact with SES's [subscription management features](https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html), you may return the `X-Ses-List-Management-Options` header in the array returned by the [`headers`](#headers) method of a mail message:
179+
To interact with SES's [subscription management features](https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html), you may return the `X-Ses-List-Management-Options` header in the array returned by the [headers](#headers) method of a mail message:
180180

181181
```php
182182
/**

Diff for: notifications.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -920,7 +920,7 @@ php artisan migrate
920920
```
921921

922922
> [!NOTE]
923-
> If your notifiable models are using [UUID or ULID primary keys](/docs/{{version}}/eloquent#uuid-and-ulid-keys), you should replace the `morphs` method with [`uuidMorphs`](/docs/{{version}}/migrations#column-method-uuidMorphs) or [`ulidMorphs`](/docs/{{version}}/migrations#column-method-ulidMorphs) in the notification table migration.
923+
> If your notifiable models are using [UUID or ULID primary keys](/docs/{{version}}/eloquent#uuid-and-ulid-keys), you should replace the `morphs` method with [uuidMorphs](/docs/{{version}}/migrations#column-method-uuidMorphs) or [ulidMorphs](/docs/{{version}}/migrations#column-method-ulidMorphs) in the notification table migration.
924924
925925
<a name="formatting-database-notifications"></a>
926926
### Formatting Database Notifications

Diff for: packages.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ Blade will automatically detect the class that's linked to this component by pas
324324
<a name="anonymous-components"></a>
325325
#### Anonymous Components
326326

327-
If your package contains anonymous components, they must be placed within a `components` directory of your package's "views" directory (as specified by the [`loadViewsFrom` method](#views)). Then, you may render them by prefixing the component name with the package's view namespace:
327+
If your package contains anonymous components, they must be placed within a `components` directory of your package's "views" directory (as specified by the [loadViewsFrom method](#views)). Then, you may render them by prefixing the component name with the package's view namespace:
328328

329329
```blade
330330
<x-courier::alert />
@@ -373,7 +373,7 @@ public function boot(): void
373373
<a name="optimize-commands"></a>
374374
### Optimize Commands
375375

376-
Laravel's [`optimize` command](/docs/{{version}}/deployment#optimization) caches the application's configuration, events, routes, and views. Using the `optimizes` method, you may register your package's own Artisan commands that should be invoked when the `optimize` and `optimize:clear` commands are executed:
376+
Laravel's [optimize command](/docs/{{version}}/deployment#optimization) caches the application's configuration, events, routes, and views. Using the `optimizes` method, you may register your package's own Artisan commands that should be invoked when the `optimize` and `optimize:clear` commands are executed:
377377

378378
```php
379379
/**

Diff for: passwords.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ By default, Laravel will respond to all requests it receives regardless of the c
3737

3838
Typically, you should configure your web server, such as Nginx or Apache, to only send requests to your application that match a given hostname. However, if you do not have the ability to customize your web server directly and need to instruct Laravel to only respond to certain hostnames, you may do so by using the `trustHosts` middleware method in your application's `bootstrap/app.php` file. This is particularly important when your application offers password reset functionality.
3939

40-
To learn more about this middleware method, please consult the [`TrustHosts` middleware documentation](/docs/{{version}}/requests#configuring-trusted-hosts).
40+
To learn more about this middleware method, please consult the [TrustHosts middleware documentation](/docs/{{version}}/requests#configuring-trusted-hosts).
4141

4242
<a name="routing"></a>
4343
## Routing

Diff for: pulse.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ If no regular expression patterns match the request's URL, then the `'default'`
404404
<a name="servers-recorder"></a>
405405
#### Servers
406406

407-
The `Servers` recorder captures CPU, memory, and storage usage of the servers that power your application for display on the [Servers](#servers-card) card. This recorder requires the [`pulse:check` command](#capturing-entries) to be running on each of the servers you wish to monitor.
407+
The `Servers` recorder captures CPU, memory, and storage usage of the servers that power your application for display on the [Servers](#servers-card) card. This recorder requires the [pulse:check command](#capturing-entries) to be running on each of the servers you wish to monitor.
408408

409409
Each reporting server must have a unique name. By default, Pulse will use the value returned by PHP's `gethostname` function. If you wish to customize this, you may set the `PULSE_SERVER_NAME` environment variable:
410410

@@ -509,7 +509,7 @@ php artisan pulse:restart
509509

510510
By default, Pulse will capture every relevant event that occurs in your application. For high-traffic applications, this can result in needing to aggregate millions of database rows in the dashboard, especially for longer time periods.
511511

512-
You may instead choose to enable "sampling" on certain Pulse data recorders. For example, setting the sample rate to `0.1` on the [`User Requests`](#user-requests-recorder) recorder will mean that you only record approximately 10% of the requests to your application. In the dashboard, the values will be scaled up and prefixed with a `~` to indicate that they are an approximation.
512+
You may instead choose to enable "sampling" on certain Pulse data recorders. For example, setting the sample rate to `0.1` on the [User Requests](#user-requests-recorder) recorder will mean that you only record approximately 10% of the requests to your application. In the dashboard, the values will be scaled up and prefixed with a `~` to indicate that they are an approximation.
513513

514514
In general, the more entries you have for a particular metric, the lower you can safely set the sample rate without sacrificing too much accuracy.
515515

@@ -671,7 +671,7 @@ You may then specify the configuration file in your CSS entrypoint:
671671
@tailwind utilities;
672672
```
673673

674-
You will also need to include an `id` or `class` attribute in your card's view that matches the selector passed to Tailwind's [`important` selector strategy](https://tailwindcss.com/docs/configuration#selector-strategy):
674+
You will also need to include an `id` or `class` attribute in your card's view that matches the selector passed to Tailwind's [important selector strategy](https://tailwindcss.com/docs/configuration#selector-strategy):
675675

676676
```blade
677677
<x-pulse::card id="top-sellers" :cols="$cols" :rows="$rows" class="$class">

Diff for: queries.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ DB::table('users')->where(function ($query) {
203203
<a name="streaming-results-lazily"></a>
204204
### Streaming Results Lazily
205205

206-
The `lazy` method works similarly to [the `chunk` method](#chunking-results) in the sense that it executes the query in chunks. However, instead of passing each chunk into a callback, the `lazy()` method returns a [`LazyCollection`](/docs/{{version}}/collections#lazy-collections), which lets you interact with the results as a single stream:
206+
The `lazy` method works similarly to [the chunk method](#chunking-results) in the sense that it executes the query in chunks. However, instead of passing each chunk into a callback, the `lazy()` method returns a [LazyCollection](/docs/{{version}}/collections#lazy-collections), which lets you interact with the results as a single stream:
207207

208208
```php
209209
use Illuminate\Support\Facades\DB;
@@ -1194,7 +1194,7 @@ $users = DB::table('users')
11941194
->get();
11951195
```
11961196

1197-
To build more advanced `having` statements, see the [`havingRaw`](#raw-methods) method.
1197+
To build more advanced `having` statements, see the [havingRaw](#raw-methods) method.
11981198

11991199
<a name="limit-and-offset"></a>
12001200
### Limit and Offset

Diff for: queues.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ class UpdateSearchIndex implements ShouldQueue, ShouldBeUnique
376376
```
377377

378378
> [!NOTE]
379-
> If you only need to limit the concurrent processing of a job, use the [`WithoutOverlapping`](/docs/{{version}}/queues#preventing-job-overlaps) job middleware instead.
379+
> If you only need to limit the concurrent processing of a job, use the [WithoutOverlapping](/docs/{{version}}/queues#preventing-job-overlaps) job middleware instead.
380380
381381
<a name="encrypted-jobs"></a>
382382
### Encrypted Jobs
@@ -523,7 +523,7 @@ public function middleware(): array
523523
}
524524
```
525525

526-
Releasing a rate limited job back onto the queue will still increment the job's total number of `attempts`. You may wish to tune your `tries` and `maxExceptions` properties on your job class accordingly. Or, you may wish to use the [`retryUntil` method](#time-based-attempts) to define the amount of time until the job should no longer be attempted.
526+
Releasing a rate limited job back onto the queue will still increment the job's total number of `attempts`. You may wish to tune your `tries` and `maxExceptions` properties on your job class accordingly. Or, you may wish to use the [retryUntil method](#time-based-attempts) to define the amount of time until the job should no longer be attempted.
527527

528528
If you do not want a job to be retried when it is rate limited, you may use the `dontRelease` method:
529529

Diff for: requests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ $name = $request->input('user.name');
370370
<a name="retrieving-stringable-input-values"></a>
371371
#### Retrieving Stringable Input Values
372372

373-
Instead of retrieving the request's input data as a primitive `string`, you may use the `string` method to retrieve the request data as an instance of [`Illuminate\Support\Stringable`](/docs/{{version}}/strings):
373+
Instead of retrieving the request's input data as a primitive `string`, you may use the `string` method to retrieve the request data as an instance of [Illuminate\Support\Stringable](/docs/{{version}}/strings):
374374

375375
```php
376376
$name = $request->string('name')->trim();

Diff for: routing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ $url = route('profile', ['id' => 1, 'photos' => 'yes']);
466466
```
467467

468468
> [!NOTE]
469-
> Sometimes, you may wish to specify request-wide default values for URL parameters, such as the current locale. To accomplish this, you may use the [`URL::defaults` method](/docs/{{version}}/urls#default-values).
469+
> Sometimes, you may wish to specify request-wide default values for URL parameters, such as the current locale. To accomplish this, you may use the [URL::defaults method](/docs/{{version}}/urls#default-values).
470470
471471
<a name="inspecting-the-current-route"></a>
472472
#### Inspecting the Current Route

Diff for: scout.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,7 @@ $orders = Order::search('Star Trek')->raw();
754754
<a name="custom-indexes"></a>
755755
#### Custom Indexes
756756

757-
Search queries will typically be performed on the index specified by the model's [`searchableAs`](#configuring-model-indexes) method. However, you may use the `within` method to specify a custom index that should be searched instead:
757+
Search queries will typically be performed on the index specified by the model's [searchableAs](#configuring-model-indexes) method. However, you may use the `within` method to specify a custom index that should be searched instead:
758758

759759
```php
760760
$orders = Order::search('Star Trek')

0 commit comments

Comments
 (0)