Repository navigation
docs: revise CLI usage documentation - #147
Conversation
- 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.
…nd give credit where it's due
Signed-off-by: Steve Piercy <web@stevepiercy.com>
|
@SashankBhamidi ready for another pass. Remaining tasks:
Please let me know. Thank you! |
SashankBhamidi
left a comment
There was a problem hiding this comment.
Nice cleanup, most of the round 1 items landed. Few smaller things:
|
@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. |
Co-authored-by: Sashank <hello@sashank.wiki> Signed-off-by: Steve Piercy <web@stevepiercy.com>
|
@SashankBhamidi back to you! Remaining items:
Although not part of this PR, the next file on my list to review and revise is Please let me know. Thank you! |
SashankBhamidi
left a comment
There was a problem hiding this comment.
On your remaining items: will be pushing a follow-up commit with the Windows PowerShell tabs for pipeline/batch examples into this PR
|
@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.
stevepiercy
left a comment
There was a problem hiding this comment.
@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
left a comment
There was a problem hiding this comment.
LGTM. Address the comment and either of us can squash merge.
Good work! Thanks!
- Repurpose phrasing from note.
SashankBhamidi
left a comment
There was a problem hiding this comment.
LGTM. Approving. Tysm.
No description provided.