Skip to content

docs: revise CLI usage documentation - #147

Merged
SashankBhamidi merged 104 commits into
mainfrom
74-docs-usage
Jun 10, 2026
Merged

SashankBhamidi merged 104 commits into
mainfrom
74-docs-usage

Conversation

@stevepiercy

Copy link
Copy Markdown
Member

No description provided.

- Fix invalid docstring format in `anonymize`
- Add vale and sphinx-autobuild for spelling, grammar, and style checking, and to automatically reload documentation in the browser while editing
Open navbar links for PyPI and GitHub in a new window.
Signed-off-by: Steve Piercy <web@stevepiercy.com>
@stevepiercy

stevepiercy commented Jun 8, 2026 •

Copy link
Copy Markdown
Member Author

@SashankBhamidi ready for another pass.

Remaining tasks:

Please let me know. Thank you!

@SashankBhamidi SashankBhamidi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice cleanup, most of the round 1 items landed. Few smaller things:

Comment thread docs/usage/cli.rst Resolved
Comment thread docs/usage/cli.rst Resolved
Comment thread docs/usage/cli.rst Resolved
Comment thread docs/usage/cli.rst Resolved
@SashankBhamidi

SashankBhamidi commented Jun 8, 2026 •

Copy link
Copy Markdown
Member

@stevepiercy Back to you! Good work!


#154: The Python snippet I drafted in the review was rough, happy to flesh it out into a proper worked example for python-api.rst as a follow-up PR after this one merges. Want me to take that on?


I'd go PowerShell, full reasoning in reply on the lexer thread. I'll handle the Windows-side testing.


@stevepiercy

stevepiercy commented Jun 9, 2026 •

Copy link
Copy Markdown
Member Author

@SashankBhamidi back to you! Remaining items:

  • Review changes.
  • Add PowerShell equivalent commands with Sphinx Design tabs.
  • Resolve any unresolved conversations.

Although not part of this PR, the next file on my list to review and revise is python-api.rst, so the snippet in #154 will get checked eventually.

Please let me know. Thank you!

@SashankBhamidi SashankBhamidi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On your remaining items: will be pushing a follow-up commit with the Windows PowerShell tabs for pipeline/batch examples into this PR

Comment thread docs/usage/cli.rst Resolved
@SashankBhamidi

Copy link
Copy Markdown
Member

@stevepiercy I approve your changes. Can you review mine? Lmk.

Thanks for the work so far, it's cool!

…elt more like a verb to me, so I changed "re-encoded" from a verb to an adjective to align with my interpretation. If it was in fact a plural noun, then I'd preface the sentence with `The `.

Also put one sentence per line.
Comment thread docs/usage/cli.rst Resolved

@stevepiercy stevepiercy left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SashankBhamidi thanks for the comprehensive examples. This is looking so good. I added synchronizing tabs, renamed one tab label for consistency, and have one new question in this review.

Otherwise I think it's good to merge. What do you think?

SashankBhamidi
SashankBhamidi previously approved these changes Jun 10, 2026

@SashankBhamidi SashankBhamidi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Address the comment and either of us can squash merge.

Good work! Thanks!

Comment thread docs/usage/cli.rst Resolved
- Repurpose phrasing from note.

@SashankBhamidi SashankBhamidi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Approving. Tysm.

@SashankBhamidi
SashankBhamidi merged commit 8c9eae6 into main Jun 10, 2026
23 of 25 checks passed
@SashankBhamidi
SashankBhamidi deleted the 74-docs-usage branch June 10, 2026 08:25
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.

2 participants