Repository navigation
[query] add many more examples to the Table docs - #14113
Merged
Merged
Conversation
Merged
added 12 commits
January 5, 2024 11:13
As written: - `make -C hail doctest` runs the normal tests. - `test_python_docs` only tests the RST files (e.g. [see this deploy](https://batch.hail.is/batches/8097884/jobs/127))
danking
commented
Jan 9, 2024
| --html=../build/reports/pytest-doctest.html \ | ||
| --doctest-modules \ | ||
| --doctest-glob='*.rst' \ | ||
| --doctest-continue-on-failure \ |
Contributor
Author
There was a problem hiding this comment.
Without this you only get the first failure in a docstring. Much easier to fix docs with this option enabled.
| 'data/ld_score_regression.all_phenos.sumstats.mt' | ||
| ) | ||
|
|
||
| print("finished setting up doctest...") |
Contributor
Author
There was a problem hiding this comment.
Notice that this message is already printed in init in this file which calls this function, generate_datasets.
patrick-schultz
previously requested changes
Jan 11, 2024
| ... dicts, | ||
| ... partial_type={"milestone":hl.tstr, "labels":hl.tarray(hl.tstr)}) | ||
| ... [{'a': 5, 'b': 10}, {'a': 0, 'b': 200}], | ||
| ... schema=hl.tstruct(a=hl.tint, b=hl.tint), |
Member
There was a problem hiding this comment.
This should omit the schema, right?
Contributor
Author
There was a problem hiding this comment.
Ah, yes, great eyes. It's also missing the example output. Updated on both counts.
patrick-schultz
approved these changes
Jan 16, 2024
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I wrote examples for several functions.