Issue 2953 (and issue 2745) Revise Track Documentation #2989
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
|
Please see PR 93 in the Python-test-runner repo for the |
.github/workflows/ci-workflow.yml
Outdated
| @@ -66,7 +66,7 @@ jobs: | |||
| run: pip install dataclasses | |||
|
|
|||
| - name: Install pytest | |||
| run: pip install pytest~=6.2.5 | |||
| run: pip install pytest | |||
There was a problem hiding this comment.
I assume this will install the latest version. Usually, I recommend pinning things in CI to prevent things from suddenly breaking. I assume you changed this because you want things to work with the latest version?
There was a problem hiding this comment.
Yes. Sadly, the latest version is the one that can use tomli. Earlier versions use the toml lib instead. However, I could pin it to the latest version (7.0.1, due to python 3.6 compatibilities).
I did have it pinned to 6.2.5 for the very reason you cited - it upgraded itself a while ago and broke everything.
However, due to a nasty combination of psf/black#2964 for Black (the formatter used in the generate_tests.py) and the move toward tomli for toml parsing in the community, I sorta had to upgrade.
Both the latest version of Black (needed in order to fix that _unicodefun error we're getting) and the latest version of Pytest use tomli. Once I changed data.py to use tomli for Black, I needed to then upgrade pytest as well..
There was a problem hiding this comment.
However, I could pin it to the latest version (7.1).
That could be a good idea. I'll let you decide of course :)
| @@ -1,19 +1,154 @@ | |||
| # Tests | |||
There was a problem hiding this comment.
There is a lot of information in this file. As this file is distributed along with every downloaded exercise, we envisioned this to be a fairly small, to reduce the likelihood of people just not reading it. Quoting the docs:
The instructions should be short and to the point.
What I often see done is to only mention the basics in this file, and then link to the track TESTS.md doc on the website for more information.
There was a problem hiding this comment.
I considered doing that. The original was quite succinct and included a pointer to the website, but I then got a lot of complaints about the pytest warnings and not being able to find information, and sort of went in the other direction.
Let me see what I can do to pare this down a bit.
There was a problem hiding this comment.
Right. That's background information I didn't have, thanks!
* added the pytest invokation pytest -o markers=task to the "running tests" sections of exercises/shared/test.md and docs/TESTS.md * updated and clarified INSTALLATION.md * updated and added new resources to LEARNING.md * updated and added new resources to RESOURCES.md * overhauled TOOLS.md and added new editors and links
…lity issue. See psf/black#2964 for details.
BethanyG
force-pushed
the
issue-2953-revise-help-docs
branch
from
854a0fb
to
1629f6f
Compare
|
Many thanks for the review @ErikSchierboom! |
Per issues #2953 and #2745, updated track student documentation.
pytest -o markers=taskinvocation toexercises/shared/tests.mdanddocs/TESTS.mdpytest.iniinstructions toexercises/shared/tests.mdanddocs/TESTS.mdINSTALLATION.md,LEARNING.md,RESOURCES.mdandTOOLS.md