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 the output of the example code #232

Merged
merged 1 commit into from
Oct 19, 2019
Merged

Conversation

kinow
Copy link
Contributor

@kinow kinow commented Aug 29, 2019

Hi,

I am trying pluggy, and after reading the README.md short example I thought I knew what would be the output, but had to run the code to confirm.

This PR adds Python comments to the code block with the results. But perhaps it could go somewhere else if others have any suggestions?

Thanks for pluggy
Bruno

@kinow
Copy link
Contributor Author

kinow commented Aug 29, 2019

Ah, just realized the readthedocs page has the results. Feel free to close if you prefer to have just the code in the README.md 👍

@goodboy
Copy link
Contributor

goodboy commented Aug 30, 2019

@kinow I'm cool with this - helps with groking the example at a glance.

I wonder can we present it in the readme in a little more of a "shell output"-y way like with literal blocks?

@kinow
Copy link
Contributor Author

kinow commented Aug 31, 2019

@goodboy good idea. Copied the text from the readthedocs site and updated the commit 👍

@goodboy goodboy requested a review from nicoddemus October 16, 2019 01:45
@goodboy goodboy merged commit a5130ac into pytest-dev:master Oct 19, 2019
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