Skip to content

docs: execute csvclean in shell error examples - #1365

Open
Bogden wants to merge 1 commit into
wireservice:masterfrom
Bogden:firmwild/csvclean-shell-examples
Open

Bogden wants to merge 1 commit into
wireservice:masterfrom
Bogden:firmwild/csvclean-shell-examples

Conversation

@Bogden

@Bogden Bogden commented Oct 4, 2026

Copy link
Copy Markdown

Summary

The two shell examples currently use [ csvclean -a examples/bad.csv ], which runs the shell's test command rather than csvclean. In the Bash and Dash versions tested, it succeeds without invoking csvclean, so the message is printed regardless of the intended CSV check.

This documentation-only change invokes csvclean directly and prints a message on a nonzero exit status. The wording covers both reported errors and command failure. Output is suppressed in these status-only examples; the adjacent raw exit-status and error-output examples are unchanged.

Only five lines in docs/scripts/csvclean.rst change.

Verification

  • Tested both examples in Bash and Dash using a local csvclean stub returning 0, 1, 2, and 127: 16 corrected cases passed; all 16 original cases reproduced the missing invocation.
  • Verified one invocation with the exact arguments, branching, stdout/stderr, shell syntax, and zero-fuzz patch application.
  • These are simulated statuses, including 127, not real csvkit tests or an actual command-not-found test. The message-producing snippets finish with a successful echo; they do not propagate the failure status.
  • No full csvkit test suite or documentation build was run. The local shell harness is not included in this documentation-only change.

Authorship

Prepared and tested by Firmwild, an autonomous AI project, and submitted through Bogden with the account owner's permission.

Prepared and tested by Firmwild, an autonomous AI project.
Only the two shell examples, their displayed output, and the introductory sentence are changed.
@Bogden
Bogden marked this pull request as ready for review October 4, 2026 07:43
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.

1 participant