From de9be6f041753b65494f945c6fc931ec73f38a01 Mon Sep 17 00:00:00 2001 From: Joseph Flinn Date: Wed, 6 Mar 2024 14:01:29 -0800 Subject: [PATCH] Fixed spelling issues --- lint-workflow-v2/README.md | 4 ++-- .../src/bitwarden_workflow_linter/rules/name_capitalized.py | 2 +- .../src/bitwarden_workflow_linter/rules/name_exists.py | 2 +- .../bitwarden_workflow_linter/rules/pinned_job_runner.py | 6 +++--- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lint-workflow-v2/README.md b/lint-workflow-v2/README.md index 557ca6d1..12dac3e1 100644 --- a/lint-workflow-v2/README.md +++ b/lint-workflow-v2/README.md @@ -65,7 +65,7 @@ All built-in `src/bitwarden_workflow_linter/rules` should have 100% code coverag We are lax on the [imperative shell](https://www.destroyallsoftware.com/screencasts/catalog/functional-core-imperative-shell) (code interacting with other systems; ie. disk, network, etc), but we strive to maintain a high coverage over the -funcationl core (objects and models). +functional core (objects and models). ``` pipenv shell @@ -133,7 +133,7 @@ By default, a new Rule needs five things: - `self.compatibility`: The list of objects this rule is compatible with. This is used to create separate instances of the Rule for each object in the Rules collection. - `self.settings`: In general, this should default to what is shown here, but allows for overrides -- `self.fn`: The function doing the actual work to check the object and enforce the standardenforcing. +- `self.fn`: The function doing the actual work to check the object and enforce the standard. `fn` can be as simple or as complex as it needs to be to run a check on a _single_ object. This linter currently does not support Rules that check against multiple objects at a time OR file level formatting (one empty between each step or diff --git a/lint-workflow-v2/src/bitwarden_workflow_linter/rules/name_capitalized.py b/lint-workflow-v2/src/bitwarden_workflow_linter/rules/name_capitalized.py index ac205542..d27dc98c 100644 --- a/lint-workflow-v2/src/bitwarden_workflow_linter/rules/name_capitalized.py +++ b/lint-workflow-v2/src/bitwarden_workflow_linter/rules/name_capitalized.py @@ -16,7 +16,7 @@ class RuleNameCapitalized(Rule): """ def __init__(self, settings: Optional[Settings] = None) -> None: - """Contructor for RuleNameCapitalized to override the Rule class. + """Constructor for RuleNameCapitalized to override the Rule class. Args: settings: diff --git a/lint-workflow-v2/src/bitwarden_workflow_linter/rules/name_exists.py b/lint-workflow-v2/src/bitwarden_workflow_linter/rules/name_exists.py index ef261bfa..94fc9237 100644 --- a/lint-workflow-v2/src/bitwarden_workflow_linter/rules/name_exists.py +++ b/lint-workflow-v2/src/bitwarden_workflow_linter/rules/name_exists.py @@ -20,7 +20,7 @@ class RuleNameExists(Rule): """ def __init__(self, settings: Optional[Settings] = None) -> None: - """Contructor for RuleNameCapitalized to override Rule class. + """Constructor for RuleNameCapitalized to override Rule class. Args: settings: diff --git a/lint-workflow-v2/src/bitwarden_workflow_linter/rules/pinned_job_runner.py b/lint-workflow-v2/src/bitwarden_workflow_linter/rules/pinned_job_runner.py index 2301e991..b84d2c92 100644 --- a/lint-workflow-v2/src/bitwarden_workflow_linter/rules/pinned_job_runner.py +++ b/lint-workflow-v2/src/bitwarden_workflow_linter/rules/pinned_job_runner.py @@ -12,9 +12,9 @@ class RuleJobRunnerVersionPinned(Rule): """Rule to enforce pinned Runner OS versions. - Using `*-latest` versions will update automatically and broken all of our workflows - in the past. To avoid this and prevent a single event from breaking the majority of - our pipelines, we pin the versions. + Using `*-latest` versions will update automatically and has broken all of + our workflows in the past. To avoid this and prevent a single event from + breaking the majority of our pipelines, we pin the versions. """ def __init__(self, settings: Optional[Settings] = None) -> None: