From 39da77d16ff8aa91815f7984540790d72b41efb3 Mon Sep 17 00:00:00 2001 From: Jennifer Power Date: Tue, 3 Oct 2023 19:22:57 -0400 Subject: [PATCH] docs: updates comment Signed-off-by: Jennifer Power --- trestlebot/transformers/csv_to_yaml.py | 1 + trestlebot/transformers/csv_transformer.py | 2 ++ trestlebot/transformers/trestle_rule.py | 2 +- trestlebot/transformers/yaml_transformer.py | 2 +- 4 files changed, 5 insertions(+), 2 deletions(-) diff --git a/trestlebot/transformers/csv_to_yaml.py b/trestlebot/transformers/csv_to_yaml.py index d1ab2ce0..8cef9941 100644 --- a/trestlebot/transformers/csv_to_yaml.py +++ b/trestlebot/transformers/csv_to_yaml.py @@ -13,6 +13,7 @@ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. +"""CSV to YAML converter for rule authoring.""" import csv import pathlib diff --git a/trestlebot/transformers/csv_transformer.py b/trestlebot/transformers/csv_transformer.py index 5c39c550..90cc40ee 100644 --- a/trestlebot/transformers/csv_transformer.py +++ b/trestlebot/transformers/csv_transformer.py @@ -14,6 +14,8 @@ # License for the specific language governing permissions and limitations # under the License. +"""CSV Tranformer for rule authoring.""" + import csv import json import logging diff --git a/trestlebot/transformers/trestle_rule.py b/trestlebot/transformers/trestle_rule.py index 87630ae9..6a52de37 100644 --- a/trestlebot/transformers/trestle_rule.py +++ b/trestlebot/transformers/trestle_rule.py @@ -14,7 +14,7 @@ # License for the specific language governing permissions and limitations # under the License. -"""Trestle Rule Dataclass.""" +"""Trestle Rule class with pydantic.""" from typing import Any, Dict, List, Optional diff --git a/trestlebot/transformers/yaml_transformer.py b/trestlebot/transformers/yaml_transformer.py index b24e227f..10f2f80c 100644 --- a/trestlebot/transformers/yaml_transformer.py +++ b/trestlebot/transformers/yaml_transformer.py @@ -14,7 +14,7 @@ # License for the specific language governing permissions and limitations # under the License. -"""YAML to CSV transformer for rule authoring.""" +"""YAML transformer for rule authoring.""" import logging from io import StringIO from typing import Any, Dict