From ac1510ce9927fb33c9bd9b2d0f1741045f254c5a Mon Sep 17 00:00:00 2001 From: Pino Toscano Date: Wed, 14 Aug 2024 10:01:15 +0200 Subject: [PATCH] Typo fixes - "calss" -> "class" - "formated" -> "formatted - "funtion" -> "function" - "requirments" -> "requirements" - "rquirement" -> "requirement" Found using codespell. Adapt one rst header accordingly. --- betelgeuse/__init__.py | 6 +++--- betelgeuse/collector.py | 4 ++-- docs/config.rst | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/betelgeuse/__init__.py b/betelgeuse/__init__.py index dac5ecc..ea93dc0 100644 --- a/betelgeuse/__init__.py +++ b/betelgeuse/__init__.py @@ -53,7 +53,7 @@ def validate_key_value_option(ctx, param, value): - """Validate an option that expects key=value formated values.""" + """Validate an option that expects key=value formatted values.""" if value is None: return try: @@ -234,12 +234,12 @@ def cli(ctx, config_module): @cli.command('requirement') @click.option( '--approver', - help='Whom the requirments will be approved by.', + help='Whom the requirements will be approved by.', multiple=True, ) @click.option( '--assignee', - help='Whom the requirments will be assigned to.', + help='Whom the requirements will be assigned to.', ) @click.option('--team', help='Team owning the requirement.',) @click.option( diff --git a/betelgeuse/collector.py b/betelgeuse/collector.py index 48b0e8e..5a8727b 100644 --- a/betelgeuse/collector.py +++ b/betelgeuse/collector.py @@ -39,7 +39,7 @@ def __init__( #: set, otherwise it will be ``None`` self.parent_class = parent_class.name #: If the testcase is a method then the parent ``ast.ClasDef`` - #: representation of the parent calss will be set, otherwise it + #: representation of the parent class will be set, otherwise it #: will be ``None`` self.parent_class_def = parent_class #: If test case is a method then the parent class docstring will be @@ -72,7 +72,7 @@ def __init__( self.pkginit_def = None self.pkginit_docstring = None #: The dictionary that will store the field values defined for the - #: testcase. The field value resolution order is the test funtion or + #: testcase. The field value resolution order is the test function or #: method docstring, the class docstring if it is a method, the module #: docstring and finally the ``__init__.py`` docstring if present. The #: first value found the search will stop. diff --git a/docs/config.rst b/docs/config.rst index 2c3c92c..ee5ccd1 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -175,8 +175,8 @@ does not validate the values on Polarion. .. literalinclude:: ../betelgeuse/default_config.py :linenos: -Rquirement objects -================== +Requirement objects +=================== .. autoclass:: betelgeuse.collector.Requirement :members: