Skip to content

Commit ff19374

Browse files
committed
docs: fix documentation audit issues and update references
1 parent 823baff commit ff19374

42 files changed

Lines changed: 70 additions & 76 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (C) 2012-2022 WP-CLI Development Group (https://github.com/wp-cli/handbook/contributors)
3+
Copyright (C) 2012-2026 WP-CLI Development Group (https://github.com/wp-cli/handbook/contributors)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎bin/Handbook_Command.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -618,9 +618,9 @@ private static function gen_cmd_pages( $cmd, $parent = [], $verbose = false ) {
618618
// Remove word wrapping from docs
619619
// Match words, '().,;', and --arg before/after the newline.
620620
$bits = explode( "\n", $docs );
621-
$in_yaml_doc = false;
622-
$in_code_bloc = false;
623-
$total_bits = count( $bits );
621+
$in_yaml_doc = false;
622+
$in_code_block = false;
623+
$total_bits = count( $bits );
624624
for ( $i = 0; $i < $total_bits; $i++ ) {
625625
if ( ! isset( $bits[ $i ] ) || ! isset( $bits[ $i + 1 ] ) ) {
626626
continue;
@@ -629,9 +629,9 @@ private static function gen_cmd_pages( $cmd, $parent = [], $verbose = false ) {
629629
$in_yaml_doc = ! $in_yaml_doc;
630630
}
631631
if ( '```' === $bits[ $i ] ) {
632-
$in_code_bloc = ! $in_code_bloc;
632+
$in_code_block = ! $in_code_block;
633633
}
634-
if ( $in_yaml_doc || $in_code_bloc ) {
634+
if ( $in_yaml_doc || $in_code_block ) {
635635
continue;
636636
}
637637

‎commands/search-replace.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ options:
9898
# Search and replace but skip one column
9999
$ wp search-replace 'http://example.test' 'http://example.com' --skip-columns=guid
100100

101-
# Run search/replace operation but dont save in database
101+
# Run search/replace operation but don't save in database
102102
$ wp search-replace 'foo' 'bar' wp_posts wp_postmeta wp_terms --dry-run
103103

104104
# Run case-insensitive regex search/replace operation (slow)

‎commands/transient/delete.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg
1212
: Key for the transient.
1313

1414
[\--network]
15-
: Delete the value of a network|site transient. On single site, this is is a specially-named cache key. On multisite, this is a global cache (instead of local to the site).
15+
: Delete the value of a network|site transient. On single site, this is a specially-named cache key. On multisite, this is a global cache (instead of local to the site).
1616

1717
[\--all]
1818
: Delete all transients.

‎commands/transient/get.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ options:
2323
\---
2424

2525
[\--network]
26-
: Get the value of a network|site transient. On single site, this is is a specially-named cache key. On multisite, this is a global cache (instead of local to the site).
26+
: Get the value of a network|site transient. On single site, this is a specially-named cache key. On multisite, this is a global cache (instead of local to the site).
2727

2828
### EXAMPLES
2929

‎commands/transient/set.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg
2020
: Time until expiration, in seconds.
2121

2222
[\--network]
23-
: Set the value of a network|site transient. On single site, this is is a specially-named cache key. On multisite, this is a global cache (instead of local to the site).
23+
: Set the value of a network|site transient. On single site, this is a specially-named cache key. On multisite, this is a global cache (instead of local to the site).
2424

2525
### EXAMPLES
2626

‎commands/user/unspam.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg
1414
# Remove user from spam.
1515
$ wp user unspam 123
1616
User 123 removed from spam.
17-
Success: Unspamed 1 of 1 users.
17+
Success: Unspammed 1 of 1 users.
1818

1919
### GLOBAL PARAMETERS
2020

‎contributions/committers-credo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Practically-speaking:
2020

2121
## Stellar judgement
2222

23-
A great product is a reflection of thoughtful, deliberate, and considered decision-making. WP-CLI committers exhibit stellar judgement with making decisions on new features, fixing bugs, merging others pull requests, and generally working on the project.
23+
A great product is a reflection of thoughtful, deliberate, and considered decision-making. WP-CLI committers exhibit stellar judgement when making decisions on new features, fixing bugs, merging others' pull requests, and generally working on the project.
2424

2525
The basis of this decision-making ensures:
2626

‎contributions/pull-requests.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ If you haven't submitted a pull request before, you'll want to install WP-CLI fo
6262
4. Install all Composer dependencies: `composer install`
6363
5. Verify WP-CLI was installed properly: `vendor/bin/wp --info`
6464

65-
Within this package, you should preferably use `vendor/bin/wp` to run the command. Just using `wp` should work as well, but by doing that you might run the command through a different version of the framework and thus getting an unexpected result.
65+
Within this package, you should preferably use `vendor/bin/wp` to run the command. Just using `wp` should work as well, but by doing that you might run the command through a different version of the framework and thus get an unexpected result.
6666

6767
### Working on the project as a whole
6868

@@ -192,7 +192,7 @@ To run the unit tests, execute:
192192

193193
To run a specific unit test, you can use:
194194

195-
composer phpunit -- filter=<method name>
195+
composer phpunit -- --filter=<method name>
196196

197197
### Running all tests in one go
198198

‎contributions/release-checklist.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Release Checklist
22

3-
There are two different release checklists available from within the [`
4-
wp-cli/wp-cli`
5-
](https://github.com/wp-cli/wp-cli) repository:
3+
There are two different release checklists available from within the [`wp-cli/wp-cli`](https://github.com/wp-cli/wp-cli) repository:
64

75
* Generate a [🚀 Regular Release Checklist](https://github.com/wp-cli/wp-cli/issues/new?assignees=schlessera&labels=i%3A+scope%3Adistribution&template=4-REGULAR_RELEASE_CHECKLIST.md&title=Release+checklist+for+v2.x.x) - applies to major (2.x.x) and minor (x.1.x) releases.
86
* Generate a [🔧 Patch Release Checklist](https://github.com/wp-cli/wp-cli/issues/new?assignees=schlessera&labels=i%3A+scope%3Adistribution&template=5-PATCH_RELEASE_CHECKLIST.md&title=Release+checklist+for+v2.x.x) - applies to patch (x.x.1) releases only.

0 commit comments

Comments
 (0)