Add documentation for regression tests #2000
Merged
Conversation
This file contains 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
|
Looks great to me. |
These instructions don't feel core to Smart Answers.
The former gives more detail than the latter.
floehopper
force-pushed
the
add-documentation-for-regression-tests
branch
from
ca913f5
to
c072ded
Compare
|
I've rebase this against master and force-pushed in preparation for merging. |
floehopper
added a commit
that referenced
this pull request
Oct 12, 2015
…on-tests Add documentation for regression tests
| # Adding new regression tests | ||
|
|
||
| 1. Update the flow to replace any single line conditionals around `Phraselist`s with multiple line conditionals. This is so that we get useful information from the running the coverage utility. Single line conditionals will show up as having been exercised irrespective of whether they caused something to be added to the `Phraselist`. | ||
|
|
There was a problem hiding this comment.
Not exactly related to this PR, but I've skimmed the codebase (using GH search) and it looks like Phraselists are nearly extinct. I think it would make sense to look at removing it as a feature.
There was a problem hiding this comment.
Thanks. Yes, I think you're right that they have (almost?) entirely disappeared from question blocks. We already have a Trello card to remove documentation associated with them: https://trello.com/c/zODxvA3Y/78-remove-documentation-references-to-phraselists
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.
I wanted to add a link to documentation about the regression tests from
CONTRIBUTING.md, but realised that none of the existing documentation was really suitable or detailed enough.This is my first stab at some more comprehensive documentation about the regression tests. Feedback welcome.
/cc @chrisroos @tadast
Expected user-visible changes