We should make sure each command has an extended description with representational examples.
Here's what I mean by...
Extended descriptions
Instead of:
Expand the description to include at least a couple sentences about what the command does:
Representational examples
Instead of:
Include a representation of the command with its most likely output.
Work list
We'll need to do a full pass through all commands, and tick them off when they're done (script to generate list ). Because the website documentation is generated from the codebase, the edits will need to be made to the PHPDoc for each command.
cache (current doc , file to edit )
cache add (current doc , file to edit )
cache decr (current doc , file to edit )
cache delete (current doc , file to edit )
cache flush (current doc , file to edit )
cache get (current doc , file to edit )
cache incr (current doc , file to edit )
cache replace (current doc , file to edit )
cache set (current doc , file to edit )
cache type (current doc , file to edit )
cap (current doc , file to edit )
cap add (current doc , file to edit )
cap list (current doc , file to edit )
cap remove (current doc , file to edit )
cli (current doc , file to edit )
cli check-update (current doc , file to edit )
cli cmd-dump (current doc , file to edit )
cli completions (current doc , file to edit )
cli info (current doc , file to edit )
cli param-dump (current doc , file to edit )
cli update (current doc , file to edit )
cli version (current doc , file to edit )
comment (current doc , file to edit )
comment approve (current doc , file to edit )
comment count (current doc , file to edit )
comment create (current doc , file to edit )
comment delete (current doc , file to edit )
comment exists (current doc , file to edit )
comment generate (current doc , file to edit )
comment get (current doc , file to edit )
comment list (current doc , file to edit )
comment meta (current doc , file to edit )
comment meta add (current doc , file to edit )
comment meta delete (current doc , file to edit )
comment meta get (current doc , file to edit )
comment meta list (current doc , file to edit )
comment meta update (current doc , file to edit )
comment recount (current doc , file to edit )
comment spam (current doc , file to edit )
comment status (current doc , file to edit )
comment trash (current doc , file to edit )
comment unapprove (current doc , file to edit )
comment unspam (current doc , file to edit )
comment untrash (current doc , file to edit )
comment update (current doc , file to edit )
comment url (current doc , file to edit )
core (current doc , file to edit )
core check-update (current doc , file to edit )
core config (current doc , file to edit )
core download (current doc , file to edit )
core install (current doc , file to edit )
core is-installed (current doc , file to edit )
core language (current doc , file to edit )
core language activate (current doc , file to edit )
core language install (current doc , file to edit )
core language list (current doc , file to edit )
core language uninstall (current doc , file to edit )
core language update (current doc , file to edit )
core multisite-convert (current doc , file to edit )
core multisite-install (current doc , file to edit )
core update (current doc , file to edit )
core update-db (current doc , file to edit )
core verify-checksums (current doc , file to edit )
core version (current doc , file to edit )
cron (current doc , file to edit )
cron event (current doc , file to edit )
cron event delete (current doc , file to edit )
cron event list (current doc , file to edit )
cron event run (current doc , file to edit )
cron event schedule (current doc , file to edit )
cron schedule (current doc , file to edit )
cron schedule list (current doc , file to edit )
cron test (current doc , file to edit )
db (current doc , file to edit )
db cli (current doc , file to edit )
db create (current doc , file to edit )
db drop (current doc , file to edit )
db export (current doc , file to edit )
db import (current doc , file to edit )
db optimize (current doc , file to edit )
db query (current doc , file to edit )
db repair (current doc , file to edit )
db reset (current doc , file to edit )
db tables (current doc , file to edit )
eval (current doc , file to edit )
eval-file (current doc , file to edit )
export (current doc , file to edit )
help (current doc , file to edit )
import (current doc , file to edit )
media (current doc , file to edit )
media import (current doc , file to edit )
media regenerate (current doc , file to edit )
menu (current doc , file to edit )
menu create (current doc , file to edit )
menu delete (current doc , file to edit )
menu item (current doc , file to edit )
menu item add-custom (current doc , file to edit )
menu item add-post (current doc , file to edit )
menu item add-term (current doc , file to edit )
menu item delete (current doc , file to edit )
menu item list (current doc , file to edit )
menu item update (current doc , file to edit )
menu list (current doc , file to edit )
menu location (current doc , file to edit )
menu location assign (current doc , file to edit )
menu location list (current doc , file to edit )
menu location remove (current doc , file to edit )
network (current doc , file to edit )
network meta (current doc , file to edit )
network meta add (current doc , file to edit )
network meta delete (current doc , file to edit )
network meta get (current doc , file to edit )
network meta list (current doc , file to edit )
network meta update (current doc , file to edit )
option (current doc , file to edit )
option add (current doc , file to edit )
option delete (current doc , file to edit )
option get (current doc , file to edit )
option list (current doc , file to edit )
option update (current doc , file to edit )
package (current doc , file to edit )
package browse (current doc , file to edit )
package install (current doc , file to edit )
package list (current doc , file to edit )
package path (current doc , file to edit )
package uninstall (current doc , file to edit )
plugin (current doc , file to edit )
plugin activate (current doc , file to edit )
plugin deactivate (current doc , file to edit )
plugin delete (current doc , file to edit )
plugin get (current doc , file to edit )
plugin install (current doc , file to edit )
plugin is-installed (current doc , file to edit )
plugin list (current doc , file to edit )
plugin path (current doc , file to edit )
plugin search (current doc , file to edit )
plugin status (current doc , file to edit )
plugin toggle (current doc , file to edit )
plugin uninstall (current doc , file to edit )
plugin update (current doc , file to edit )
post (current doc , file to edit )
post create (current doc , file to edit )
post delete (current doc , file to edit )
post edit (current doc , file to edit )
post generate (current doc , file to edit )
post get (current doc , file to edit )
post list (current doc , file to edit )
post meta (current doc , file to edit )
post meta add (current doc , file to edit )
post meta delete (current doc , file to edit )
post meta get (current doc , file to edit )
post meta list (current doc , file to edit )
post meta update (current doc , file to edit )
post term (current doc , file to edit )
post term add (current doc , file to edit )
post term list (current doc , file to edit )
post term remove (current doc , file to edit )
post term set (current doc , file to edit )
post update (current doc , file to edit )
post-type (current doc , file to edit )
post-type get (current doc , file to edit )
post-type list (current doc , file to edit )
rewrite (current doc , file to edit )
rewrite flush (current doc , file to edit )
rewrite list (current doc , file to edit )
rewrite structure (current doc , file to edit )
role (current doc , file to edit )
role create (current doc , file to edit )
role delete (current doc , file to edit )
role exists (current doc , file to edit )
role list (current doc , file to edit )
role reset (current doc , file to edit )
scaffold (current doc , file to edit )
scaffold _s (current doc , file to edit )
scaffold child-theme (current doc , file to edit )
scaffold plugin (current doc , file to edit )
scaffold plugin-tests (current doc , file to edit )
scaffold post-type (current doc , file to edit )
scaffold taxonomy (current doc , file to edit )
search-replace (current doc , file to edit )
server (current doc , file to edit )
shell (current doc , file to edit )
sidebar (current doc , file to edit )
sidebar list (current doc , file to edit )
site (current doc , file to edit )
site activate (current doc , file to edit )
site archive (current doc , file to edit )
site create (current doc , file to edit )
site deactivate (current doc , file to edit )
site delete (current doc , file to edit )
site empty (current doc , file to edit )
site list (current doc , file to edit )
site spam (current doc , file to edit )
site unarchive (current doc , file to edit )
site unspam (current doc , file to edit )
super-admin (current doc , file to edit )
super-admin add (current doc , file to edit )
super-admin list (current doc , file to edit )
super-admin remove (current doc , file to edit )
taxonomy (current doc , file to edit )
taxonomy get (current doc , file to edit )
taxonomy list (current doc , file to edit )
term (current doc , file to edit )
term create (current doc , file to edit )
term delete (current doc , file to edit )
term generate (current doc , file to edit )
term get (current doc , file to edit )
term list (current doc , file to edit )
term meta (current doc , file to edit )
term meta add (current doc , file to edit )
term meta delete (current doc , file to edit )
term meta get (current doc , file to edit )
term meta list (current doc , file to edit )
term meta update (current doc , file to edit )
term recount (current doc , file to edit )
term update (current doc , file to edit )
term url (current doc , file to edit )
theme (current doc , file to edit )
theme activate (current doc , file to edit )
theme delete (current doc , file to edit )
theme disable (current doc , file to edit )
theme enable (current doc , file to edit )
theme get (current doc , file to edit )
theme install (current doc , file to edit )
theme is-installed (current doc , file to edit )
theme list (current doc , file to edit )
theme mod (current doc , file to edit )
theme mod get (current doc , file to edit )
theme mod remove (current doc , file to edit )
theme mod set (current doc , file to edit )
theme path (current doc , file to edit )
theme search (current doc , file to edit )
theme status (current doc , file to edit )
theme update (current doc , file to edit )
transient (current doc , file to edit )
transient delete (current doc , file to edit )
transient delete-all (current doc , file to edit )
transient delete-expired (current doc , file to edit )
transient get (current doc , file to edit )
transient set (current doc , file to edit )
transient type (current doc , file to edit )
user (current doc , file to edit )
user add-cap (current doc , file to edit )
user add-role (current doc , file to edit )
user create (current doc , file to edit )
user delete (current doc , file to edit )
user generate (current doc , file to edit )
user get (current doc , file to edit )
user import-csv (current doc , file to edit )
user list (current doc , file to edit )
user list-caps (current doc , file to edit )
user meta (current doc , file to edit )
user meta add (current doc , file to edit )
user meta delete (current doc , file to edit )
user meta get (current doc , file to edit )
user meta list (current doc , file to edit )
user meta update (current doc , file to edit )
user remove-cap (current doc , file to edit )
user remove-role (current doc , file to edit )
user set-role (current doc , file to edit )
user term (current doc , file to edit )
user term add (current doc , file to edit )
user term list (current doc , file to edit )
user term remove (current doc , file to edit )
user term set (current doc , file to edit )
user update (current doc , file to edit )
widget (current doc , file to edit )
widget add (current doc , file to edit )
widget deactivate (current doc , file to edit )
widget delete (current doc , file to edit )
widget list (current doc , file to edit )
widget move (current doc , file to edit )
widget update (current doc , file to edit )
We should make sure each command has an extended description with representational examples.
Here's what I mean by...
Extended descriptions
Instead of:
Expand the description to include at least a couple sentences about what the command does:
Representational examples
Instead of:
Include a representation of the command with its most likely output.
Work list
We'll need to do a full pass through all commands, and tick them off when they're done (script to generate list). Because the website documentation is generated from the codebase, the edits will need to be made to the PHPDoc for each command.