Add docs for #180 #651
Merged
Add docs for #180 #651
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I have fixed the typo. The other failing tests looks like a temporary networking issue. |
|
@hynek thanks for sending this! There's actually an even easier way to accomplish the example shown: commit = session.run("git", "rev-parse", "--short", "HEAD", external=True, silent=True) |
|
aaargh now i understand Henry's comment. I never read the full help string b/c i didn't want silence. I guess i'll just rewrite example (but leave the new API docs)? 😅 |
|
Yeah that would be awesome. It's still a useful thing to document, I'd just
want it to have a more practical example.
…On Wed, Sep 14, 2022 at 10:46 AM Hynek Schlawack ***@***.***> wrote:
aaargh now i understand Henry's comment
<#218 (comment)>. I
never read the full help string b/c i didn't want silence.
I guess i'll just rewrite example (but leave the new API docs)? 😅
—
Reply to this email directly, view it on GitHub
<#651 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAB5I4ZAQCAYBT3QEYGJKKLV6HQLPANCNFSM6AAAAAAQLHX4MA>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
|
Yeah, it's worthy to document this. The CI failed, so I decided to re-run the failed checks. Actually, I ran the CI for the latest commit. |
|
I've rewritten the example and clarified the arguments of stdout/stderr. I don't think they need their own examples; with silent=True they're rather fringe options. |
theacodes
approved these changes
Sep 16, 2022
|
Thank you so much, @hynek! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I found this extremely useful feature only by accident and Googling!
Not sure if y'all enjoy retroactive changelog editing…