extract_descriptions.py should support test functions as well
#124
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
nrichers
requested changes
Jun 26, 2024
There was a problem hiding this comment.
I tested this PR locally with the documentation repo and it's a definite improvement but there are still some blank test descriptions, e.g. TrainingTestDegradation.
How I tested:
- Modify our documentation Makefile to clone this PR branch.
- Run
make get-sourcewhich clones this branch and then generate the test descriptions. - Run
quarto previewto check the output. - To verify there is an issue, also checked out this PR and ran
poetry run python scripts/extract_descriptions.py validmind/testslocally — same issue.
You can see the results of my test here, including screenshots: validmind/documentation#229
|
@nrichers could you give it another try? I made additional fixes and it should now capture all edge cases. |
nrichers
approved these changes
Jun 28, 2024
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.
Internal Notes for Reviewers
Ticket: Some test descriptions are empty
extract_descriptions.pyshould support test functions as wellExternal Release Notes