-
Notifications
You must be signed in to change notification settings - Fork 117
[doc] Update documentation of built-ins and update tutorial examples removing the use of __init__
#1940
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
Conversation
ekouts
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm in general, I had two very small comments while reading again the documentation
|
Hello @jjotero, Thank you for updating! Cheers! There are no PEP8 issues in this Pull Request!Do see the ReFrame Coding Style Guide Comment last updated at 2021-04-26 21:51:16 UTC |
Codecov Report
@@ Coverage Diff @@
## master #1940 +/- ##
==========================================
- Coverage 87.90% 87.89% -0.01%
==========================================
Files 50 50
Lines 8620 8627 +7
==========================================
+ Hits 7577 7583 +6
- Misses 1043 1044 +1
Continue to review full report at Codecov.
|
|
@jenkins-cscs retry dom |
vkarak
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One additional thing we could do is to add note somewhere in the first tutorial saying that the classic way of setting up a test in its __init__() is still valid and not deprecated.
vkarak
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just found a minor typo. @teojgo Are you fine moving the sanity_patterns definition to the class body in the container_test?
__init__
|
I was about to merge it, but the CI of the tutorials fails. I fixed a couple of typos, but @jjotero can you fix the rest? |
variablebuilt-in was out of date. This section has now been updated to show its current capabilities.parameterbuilt-in section indicating that theparameterized_testdecorator will be deprecated.The basic examples shown in the built-ins section are good enough to illustrate their capabilities, so there is no need to add another tutorial explaining these. Instead, a statement has been added in the introduction of the
Writing reusable teststutorial encouraging users to read the basic examples from the built-ins section of the ReFrame manual.Closes #1935.
This also relates to #1899.