Add example revolving around Twitch data to documentation #48
+3,682
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #48 +/- ##
=======================================
Coverage 93.90% 93.90%
=======================================
Files 15 15
Lines 1607 1607
=======================================
Hits 1509 1509
Misses 98 98 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
kklein
changed the title
ivergara
approved these changes
Aug 12, 2022
| Now let's write an actual specification, expressing our expectations against the data. | ||
| First, we need to make sure a connection to database can be established at test execution | ||
| time. How this is done exactly depends on how you set up your database. When using our | ||
| default setup with running `$ ./start_postgres.sh <https://github.com/Quantco/datajudge/blob/main/start_postgres.sh>`_, |
There was a problem hiding this comment.
Probably here would be good to mention it's a container-based setup.
There was a problem hiding this comment.
Good point! I restructured this a bit to talk about the dockerized setup at the very beginning.
| FAILED twitch_specification.py::test_func[NumericMean::public.twitch_v2 | public.twitch_v2] - Ass... | ||
| =================================== 4 failed, 4 passed in 1.80s ==================================== | ||
|
|
||
| So we see that we might not want to trust version 2 of the data as is. What exactly do we |
There was a problem hiding this comment.
Suggested change
| So we see that we might not want to trust version 2 of the data as is. What exactly do we | |
| So we see that we might not want to blindly trust version 2 of the data as is, and that a new exploration might be in order. What exactly do we |
There was a problem hiding this comment.
I was unfamiliar with this usage of the expression 'in order' and took the liberty to rephrase slightly.
Co-authored-by: Ignacio Vergara Kausel <ivergarakausel@gmail.com>
Co-authored-by: Ignacio Vergara Kausel <ivergarakausel@gmail.com>
|
Thanks a lot for the blazingly fast review @ivergara :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
You can find a rendered version of the new example in the docs here:
https://datajudge--48.org.readthedocs.build/en/48/examples/example_twitch.html