Skip to content

Implement sphobjinv-textconv and remove CLI implementation section from docs#331

Merged
bskinn merged 38 commits intomainfrom
textconv-alt
Jan 6, 2026
Merged

Implement sphobjinv-textconv and remove CLI implementation section from docs#331
bskinn merged 38 commits intomainfrom
textconv-alt

Conversation

@bskinn
Copy link
Owner

@bskinn bskinn commented Jan 6, 2026

  • Implement sphobjinv-textconv entrypoint
    • Add tests
    • Add docs
  • Remove 'CLI implementation' section from docs
    • It's not public API, and doesn't really provide any insight into how the CLI works, so why maintain it?
  • Do a bit of further docs revision

Closes #295. Supersedes #312.

The matching revision to .git/config was:

[diff "objects_inv"]
	textconv = sh -c 'sphobjinv co plain "$0" -'
Lots to still be fixed/removed
No subparser name in the params for it to query when we're
running textconv
Regular convert stuff not relevant
Also make a short version output for textconf entrypoint.

Want 'infile' to show as required in the help, and looks like it's not
currently possible to render a multiline version string using
the 'version' action; and, treating -v as a normal flag means that
the inputs fail to parse when no 'infile' is passed.
No subparser for textconv, so no need for subparser tests
The main entrypoint is no longer the only one defined on the project.
RtD context doesn't have the Git config in place, statically, so we
have to provide it with the invocation.
It's an internal interface, we want to discourage people
from using it directly in code.

Replace the couple of meaningful references to CLI-related constants
with automatically-substituted-in current values of those constants
Meaningless at best, and actively confusing at worst. Best to
remove it.
@bskinn bskinn marked this pull request as ready for review January 6, 2026 05:32
@bskinn bskinn merged commit 9b6415f into main Jan 6, 2026
21 checks passed
@bskinn bskinn deleted the textconv-alt branch January 6, 2026 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

act as textconv so can git diff inventory

1 participant