Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for #180 #651

Merged
merged 3 commits into from
Sep 16, 2022
Merged

Add docs for #180 #651

merged 3 commits into from
Sep 16, 2022

Conversation

hynek
Copy link
Contributor

@hynek hynek commented Sep 13, 2022

I found this extremely useful feature only by accident and Googling!

Not sure if y'all enjoy retroactive changelog editing…

@hynek
Copy link
Contributor Author

hynek commented Sep 14, 2022

I have fixed the typo. The other failing tests looks like a temporary networking issue.

@theacodes
Copy link
Collaborator

@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)

@hynek
Copy link
Contributor Author

hynek commented Sep 14, 2022

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)? 😅

@theacodes
Copy link
Collaborator

theacodes commented Sep 14, 2022 via email

@DiddiLeija
Copy link
Collaborator

DiddiLeija commented Sep 14, 2022

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.

@hynek
Copy link
Contributor Author

hynek commented Sep 15, 2022

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
Copy link
Collaborator

Thank you so much, @hynek!

@theacodes theacodes merged commit 3fb4fbc into wntrblm:main Sep 16, 2022
@hynek hynek deleted the docs-180 branch September 16, 2022 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants