Skip to content

Enhance help sync test to verify subcommand documentation #1596

@bjcoombs

Description

@bjcoombs

Summary

Follow-up to #1594. The current help sync test only checks if commands exist in help documentation, not if their subcommands/options are correctly documented.

Problem

PR #1593 fixed outdated help documentation where:

  • tags showed old commands (add-tag, use-tag) instead of new subcommand structure (tags add, tags use)
  • list was missing new options (--watch, --ready, --blocking)

The test in #1595 wouldn't catch these issues because it only verifies command existence.

Proposed Enhancement

Add verification that:

  1. tags subcommands are documented (tags add, tags use, tags remove, tags rename, tags copy, tags list)
  2. Key command options are documented (e.g., list shows --watch, --ready, --blocking)

Dependencies

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions