Skip to content

Commit 39b5871

Browse files
Fix grammar, casing, and typo across testing docs and prek scripts (#72252)
- Follow Dag naming conventions in dag_testing.rst and airflow_e2e_tests.rst. - Fix missing preposition and casing in airflow_e2e_tests.rst. - Fix typo 'consolidte' -> 'consolidate' in check_supervisor_schemas_versions.py.
1 parent 5dcee04 commit 39b5871

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

contributing-docs/testing/airflow_e2e_tests.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ Running E2E Tests
4949
Adding new E2E Tests
5050
--------------------
5151

52-
1. To Add new Dags for E2E tests, you can add them to the dags folder in ``./airflow-e2e-tests/tests/dags`` and update
53-
the DAG_IDS constant in ``./airflow-e2e-tests/tests/basic_tests/test_example_dags.py`` file to include the new Dags ids.
54-
This will trigger Dag execution and validate the Dag run successfully.
52+
1. To add new Dags for E2E tests, you can add them to the dags folder in ``./airflow-e2e-tests/tests/dags`` and update
53+
the DAG_IDS constant in ``./airflow-e2e-tests/tests/basic_tests/test_example_dags.py`` file to include the new Dag IDs.
54+
This will trigger Dag execution and validate that the Dag runs successfully.
5555

56-
2. To add new test cases, create a new test file or add it any existing files in the ``./airflow-e2e-tests/tests/*``
56+
2. To add new test cases, create a new test file or add it to any existing files in ``./airflow-e2e-tests/tests/*``.
5757

5858

5959
Airflow E2E tests in CI

contributing-docs/testing/dag_testing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Dag Testing
2020
===========
2121

2222
To ease and speed up the process of developing Dags, you can use
23-
py:meth:`~airflow.models.dag.DAG.test`, which will run a dag in a single process.
23+
py:meth:`~airflow.models.dag.DAG.test`, which will run a Dag in a single process.
2424

2525
To set up the IDE:
2626

@@ -35,15 +35,15 @@ To set up the IDE:
3535
2. Run and debug the Dag file.
3636

3737

38-
You can also run the dag in the same manner with the Airflow CLI command ``airflow dags test``:
38+
You can also run the Dag in the same manner with the Airflow CLI command ``airflow dags test``:
3939

4040
.. code-block:: bash
4141
4242
# airflow dags test [dag_id] [execution_date]
4343
airflow dags test example_branch_operator 2018-01-01
4444
4545
By default ``/files/dags`` folder is mounted from your local ``<AIRFLOW_SOURCES>/files/dags`` and this is
46-
the directory used by Airflow scheduler and webserver to scan dags for. You can place your dags there
46+
the directory used by Airflow scheduler and webserver to scan Dags for. You can place your Dags there
4747
to test them.
4848

4949
The Dags can be run in the main version of Airflow but they also work

scripts/ci/prek/check_supervisor_schemas_versions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
DUMP_SCRIPT = Path(__file__).parent / "dump_supervisor_schemas.py"
5858

5959

60-
# TODO: We should consolidte the common logic with check_execution_api_versions.py into common_prek_utils
60+
# TODO: We should consolidate the common logic with check_execution_api_versions.py into common_prek_utils
6161
def get_target_branch() -> str:
6262
"""Branch to compare against. GITHUB_BASE_REF for PRs, DEFAULT_BRANCH in CI, else main."""
6363
return os.environ.get("GITHUB_BASE_REF") or os.environ.get("DEFAULT_BRANCH") or "main"

0 commit comments

Comments
 (0)