Skip to content

Avoid the generic terminology used for term and meta subcommand descriptions #166

Closed as not planned

Description

@johnbillion

The descriptions for the second-level subcommands of wp post|user term|meta use generic "object" terminology from the method docblocks in the abstract CommandWithTerms and CommandWithMeta classes. For example:

  • wp post term --help correctly says "Adds, updates, removes, and lists post terms."
  • wp post term list --help uses the generic phrase "List all terms associated with an object."

Generic terminology is used for all four term and meta subcommands:

wp (post|user) (term|meta) (add|list|remove|set) --help

It would be great if the descriptions and argument synopses for these commands didn't use generic terminology.

Activity

  1. schlessera commented on Apr 19, 2018

    @schlessera
    Member

    This is because most of the code is in a shared abstract class, so the docblocks only exist once for all "objects".

    I agree that it would be preferable to get rid of the generic terms, though. I'll have a look to see how best to achieve that without copying the logic around.

  2. swissspidy commented on Jan 20, 2026

    @swissspidy
    Member

    #561 did try to copy all the docblocks, but I don't really like it.

    What if we add some (Mustache) template placeholders in the docblock and then the framework would replace them upon loading?

  3. swissspidy commented on Mar 27, 2026

    @swissspidy
    Member

    What if we add some (Mustache) template placeholders in the docblock and then the framework would replace them upon loading?

    Would be nice, but also a bit overkill I suppose. Let's revisit this again in the future if desired.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions