Skip to content

Align symbols --results-only support with the README contract #4688

Description

@Widthdom

Summary

The README says the default NDJSON output of search, symbols, and files can suppress the terminal record with --results-only, but cdidx symbols --results-only rejects the flag as unsupported.

Reproduction

$ dotnet ./src/CodeIndex/bin/Debug/net8.0/cdidx.dll symbols --db .cdidx/codeindex.db --json --results-only --lang python --kind import --limit 1
Error [E010_USAGE_ERROR]: --results-only is not supported for symbols.

Observed with locally built cdidx v1.38.0 from current origin/main while validating #4615.

Expected

Either support --results-only for the documented symbols NDJSON stream or narrow the README contract so it does not advertise the flag for symbols. Add a CLI/documentation contract test for the chosen behavior.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions