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 note of minimum supported pytest version to docs #7858

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

eleanorjboyd
Copy link
Member

to help with some confusion users had when getting incompatibility while using pytest 6.2.5 I would like to add a note of 7.0.0 as the min supported version for pytest in the extension. Open to suggestions if you think it should be presented / included in a different way.

Thanks!

Copy link
Contributor

@ntrogh ntrogh left a comment

Choose a reason for hiding this comment

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

For discoverability, maybe this could be moved to the top of the article?
Either right after the intro sentence, or you could add an H2 Prerequisites section.

BTW, we now support the GH markdown alert syntax to make it pop more.

@cwebster-99
Copy link
Member

I like the idea of a pre-reqs section although I am not sure what else we could include there. I do think we should move it either to the beginning of the "Configure Tests" section or to the top of the article.

@cwebster-99
Copy link
Member

After looking at this, I am realizing we should probably ax some of the top section. It is very wordy and presents users with a wall of text before they learn about the features we offer.

@ntrogh
Copy link
Contributor

ntrogh commented Dec 13, 2024

There's a Testing article now, which you can refer to instead of that introductory section.
Wdyt?

https://code.visualstudio.com/docs/editor/testing

@eleanorjboyd
Copy link
Member Author

I am good with anything- whatever yall decide works for me! Happy to make edits when you have a final answer or you can take over the PR, thanks!

@cwebster-99
Copy link
Member

Let's remove the entire "background on unit testing" section and start with the example walkthroughs. We can leave the links for background and add a link to VS Code's testing page

For a general background on unit testing, read Unit testing on Wikipedia. For useful unit test examples, you can review https://github.com/gwtw/py-sorting, a repository with tests for different sorting algorithms.

@eleanorjboyd
Copy link
Member Author

@cwebster-99 if you want to remove that section I am happy to just merge it now as that is probably simpler than waiting?

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.

3 participants