[TEST] clarified skip features usage

elastic · Jan 31, 2014 · cf7f1b0 · cf7f1b0
1 parent 0cce4e3
commit cf7f1b0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/rest-api-spec/test/README.asciidoc b/rest-api-spec/test/README.asciidoc
@@ -88,6 +88,8 @@ The skip section can also be used to list new features that need to be
 supported in order to run a test. This way the up-to-date runners will
 run the test, while the ones that don't support the feature yet can
 temporarily skip it, and avoid having lots of test failures in the meantime.
+Once all runners have implemented the feature, it can be declared supported
+by default, thus the related skip sections can be removed from the tests.
 
 ....
     "Parent":

diff --git a/src/test/java/org/elasticsearch/test/rest/support/Features.java b/src/test/java/org/elasticsearch/test/rest/support/Features.java
@@ -27,6 +27,9 @@
  * Allows to register additional features supported by the tests runner.
  * This way any runner can add extra features and use proper skip sections to avoid
  * breaking others runners till they have implemented the new feature as well.
+ *
+ * Once all runners have implemented the feature, it can be removed from the list
+ * and the related skip sections can be removed from the tests as well.
  */
 public final class Features {