rename the plugin example and its rule

adrienverge · Oct 4, 2020 · db749b4 · db749b4
1 parent 1c5c6a4
commit db749b4
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/tests/plugins/example/__init__.py b/tests/plugins/example/__init__.py
@@ -18,9 +18,9 @@
 """
 from __future__ import absolute_import
 
-from . import override_comments
+from . import forbid_comments
 
 
 RULES = (
-    (override_comments.ID, override_comments),
+    (forbid_comments.ID, forbid_comments),
 )
diff --git a/tests/plugins/example/override_comments.py → tests/plugins/example/forbid_comments.py b/tests/plugins/example/override_comments.py → tests/plugins/example/forbid_comments.py
@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Use this rule to override some comments' rules.
+Use this rule to forbid comments.
 
 .. rubric:: Options
 
@@ -24,7 +24,7 @@
 
 .. rubric:: Examples
 
-#. With ``override-comments: {forbid: true}``
+#. With ``forbid-comments: {forbid: true}``
 
    the following code snippet would **PASS**:
    ::
@@ -42,14 +42,14 @@
 .. code-block:: yaml
 
 rules:
-  override-comments:
+  forbid-comments:
     forbid: False
 
 """
 from yamllint.linter import LintProblem
 
 
-ID = 'override-comments'
+ID = 'forbid-comments'
 TYPE = 'comment'
 CONF = {'forbid': bool}
 DEFAULT = {'forbid': False}

diff --git a/tests/test_plugins.py b/tests/test_plugins.py
@@ -48,15 +48,15 @@ class PluginFunctionsTestCase(unittest.TestCase):
 
     def test_validate_rule_module(self):
         fun = yamllint.plugins.validate_rule_module
-        rule_mod = example.override_comments
+        rule_mod = example.forbid_comments
 
         self.assertFalse(fun(object()))
         self.assertTrue(fun(rule_mod))
 
     @unittest.skipIf(not mock, "unittest.mock is not available")
     def test_validate_rule_module_using_mock(self):
         fun = yamllint.plugins.validate_rule_module
-        rule_mod = example.override_comments
+        rule_mod = example.forbid_comments
 
         with mock.patch.object(rule_mod, "ID", False):
             self.assertFalse(fun(rule_mod))

diff --git a/tests/test_rules.py b/tests/test_rules.py
@@ -51,8 +51,8 @@ def test_get_default_rule_with_plugins(self):
                              yamllint.rules.braces)
 
     def test_get_plugin_rules(self):
-        plugin_rule_id = example.override_comments.ID
-        plugin_rule_mod = example.override_comments
+        plugin_rule_id = example.forbid_comments.ID
+        plugin_rule_mod = example.forbid_comments
 
         with mock.patch.dict(yamllint.rules._EXTERNAL_RULES, PLUGIN_RULES):
             self.assertEqual(yamllint.rules.get(plugin_rule_id),