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

Update README to provide more clear examples #105

Merged
merged 3 commits into from
Feb 3, 2025

Conversation

alissa-huskey
Copy link
Contributor

I updated the README with some of my own code examples and did a little cleanup/polish.

  • Replace "Quickstart" section with the code for the simplest possible use-case.
  • Replace WSGI example, as I wasn't able to get the previous example working.
  • Rename the previous "Quickstart" section to "How-To".
  • Rename "Available funcargs" section to "Fixtures". (That seems to be the more common term. In any case, I didn't previously know that "funcargs" was another term for "fixtures", so it may be more clear to others as well.)
  • Use code directives instead of literal blocks to syntax highlight python code.

@diazona
Copy link
Contributor

diazona commented Jan 29, 2025

Hi @alissa-huskey, thanks for sending a contribution! I'm sorry to keep you waiting; I haven't been active on GitHub for a little while (because real life got busy) and I didn't see the notification about your PR.

If you don't mind waiting a bit longer, I'd like to come back to this and review it over the weekend when I can give it my full attention.

Copy link
Contributor

@diazona diazona left a comment

Choose a reason for hiding this comment

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

Thanks again! These changes mostly look good, I just made a few suggestions.

Sorry again for the delayed response; I'll try to keep checking back so I don't miss further activity here.

@diazona diazona requested a review from redtoad February 2, 2025 06:49
@alissa-huskey
Copy link
Contributor Author

No worries about the delay! Real life happens. I tend to be on github in fits and starts anyway, so I never expect a prompt response, if any.

I believe I addressed all of your feedback. Additionally I changed the monkeypatch link to point to the stable pytest.org docs URL.

Copy link
Contributor

@diazona diazona left a comment

Choose a reason for hiding this comment

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

Good call on that monkeypatch change.

Thanks again; I appreciate both the contribution and your patience!

@diazona
Copy link
Contributor

diazona commented Feb 3, 2025

I think the CI failures are because of #110, so I'll merge that and then get this finalized.

This brings in the fix to CI for Python 3.7.
@diazona diazona merged commit 853b896 into pytest-dev:master Feb 3, 2025
44 checks passed
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