Skip to content

docs(cli): surface --code-only in the extract usage and README (#2071)#2075

Open
HerenderKumar wants to merge 1 commit into
Graphify-Labs:v8from
HerenderKumar:docs-surface-code-only-flag
Open

docs(cli): surface --code-only in the extract usage and README (#2071)#2075
HerenderKumar wants to merge 1 commit into
Graphify-Labs:v8from
HerenderKumar:docs-surface-code-only-flag

Conversation

@HerenderKumar

Copy link
Copy Markdown
Contributor

Fixes #2071.

--code-only has been in the top-level graphify --help since #1734, but two other surfaces still never mention it:

  • The graphify extract usage string (printed on an empty/bad invocation) lists --no-cluster, --no-gitignore, --postgres, --cargo… but not --code-only.
  • The README documents the concept ("a code-only corpus requires no API key") but never the actual flag.

Someone evaluating graphify under a "can this run with no network call?" constraint reads the extract usage / README first, so they can reasonably conclude the flag doesn't exist — which is exactly what the reporter almost did before finding it by triggering the no-key error.

Changes

  • graphify/cli.py — add [--code-only] to the extract usage string.
  • README.md — name --code-only in the Privacy section, and add it to the command reference.
  • tests/test_extract_code_only_cli.py — new test_extract_usage_advertises_code_only asserting the usage advertises the flag.

Verification

  • tests/test_extract_code_only_cli.py — 9 passed (incl. the new test)
  • tests/test_extract_cli.py — 25 passed

…ify-Labs#2071)

The top-level `graphify --help` has listed --code-only since Graphify-Labs#1734, but the
`graphify extract` usage string and the README never mentioned it. A user
evaluating graphify on a "can this run with no network call" constraint sees
the extract usage / README first and can conclude the flag doesn't exist.

Add --code-only to the extract usage line, name it in the Privacy section and
the command reference, and add a test asserting the usage advertises it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

--code-only is missing from --help and the README

1 participant