Skip to content

Commit bfbdba8

Browse files
Merge pull request #14 from wp-cli/readme-description
Improve the top-level command descriptions even further
2 parents 21e2287 + 9308abe commit bfbdba8

File tree

3 files changed

+23
-7
lines changed

3 files changed

+23
-7
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,18 @@ This package implements the following commands:
1313

1414
### wp cache
1515

16-
Manage the object cache.
16+
Manipulate the WP Object Cache object.
1717

1818
~~~
1919
wp cache
2020
~~~
2121

22-
Use a persistent object cache drop-in to persist cache values between requests.
22+
By default, the WP Object Cache exists in PHP memory for the length of the
23+
request (and is emptied at the end). Use a persistent object cache drop-in
24+
to persist the object cache between requests.
25+
26+
[Read the codex article](https://codex.wordpress.org/Class_Reference/WP_Object_Cache)
27+
for more detail.
2328

2429
**EXAMPLES**
2530

@@ -35,12 +40,16 @@ Use a persistent object cache drop-in to persist cache values between requests.
3540

3641
### wp transient
3742

38-
Manage transients.
43+
Manipulate the WordPress Transient Cache.
3944

4045
~~~
4146
wp transient
4247
~~~
4348

49+
By default, the transient cache uses the WordPress database to persist values
50+
between requests. When a persistent object cache drop-in is installed, the
51+
transient cache also uses the WordPress Object Cache.
52+
4453
**EXAMPLES**
4554

4655
# Set transient.

src/Cache_Command.php

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
<?php
22

33
/**
4-
* Manipulates the WP Object Cache.
4+
* Manipulate the WP Object Cache object.
55
*
6+
* By default, the WP Object Cache exists in PHP memory for the length of the
7+
* request (and is emptied at the end). Use a persistent object cache drop-in
8+
* to persist the object cache between requests.
69
*
7-
* Use a persistent object cache drop-in to persist cache values between requests.
8-
* [WP Object Cache](https://codex.wordpress.org/Class_Reference/WP_Object_Cache)
10+
* [Read the codex article](https://codex.wordpress.org/Class_Reference/WP_Object_Cache)
11+
* for more detail.
912
*
1013
* ## EXAMPLES
1114
*

src/Transient_Command.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
<?php
22

33
/**
4-
* Manage WordPress transient and standardized way of storing cached data in the database temporarily base.
4+
* Manipulate the WordPress Transient Cache.
5+
*
6+
* By default, the transient cache uses the WordPress database to persist values
7+
* between requests. When a persistent object cache drop-in is installed, the
8+
* transient cache also uses the WordPress Object Cache.
59
*
610
* ## EXAMPLES
711
*

0 commit comments

Comments
 (0)