Updated typos and notation

src/pe_reports/pages.py

@@ -40,7 +40,7 @@ def overview(prs):
         slide = prs.slides[1]
         shape = Paragraph.shapes(prs, slide)
 
-        # Overeview Value - Credentials exposed in recent posts
+        # Overview Value - Credentials exposed in recent posts
         ov_val_01 = Paragraph.text_frame_ov_val(prs, slide, shape, "TextBox 2")
         frame = ov_val_01.paragraphs[0]
         run = frame.add_run()
@@ -49,7 +49,7 @@ def overview(prs):
         font = run.font
         font = Paragraph.text_style_ov_val(prs, font)
 
-        # Overeview Value - Suspected domain masquerading alerts
+        # Overview Value - Suspected domain masquerading alerts
         ov_val_02 = Paragraph.text_frame_ov_val(prs, slide, shape, "TextBox 82")
         frame = ov_val_02.paragraphs[0]
         run = frame.add_run()
@@ -58,7 +58,7 @@ def overview(prs):
         font = run.font
         font = Paragraph.text_style_ov_val(prs, font)
 
-        # Overeview Value - Active malware associations
+        # Overview Value - Active malware associations
         ov_val_03 = Paragraph.text_frame_ov_val(prs, slide, shape, "TextBox 86")
         frame = ov_val_03.paragraphs[0]
         run = frame.add_run()
@@ -67,7 +67,7 @@ def overview(prs):
         font = run.font
         font = Paragraph.text_style_ov_val(prs, font)
 
-        # Overeview Value - Web and dark web mentions
+        # Overview Value - Web and dark web mentions
         ov_val_04 = Paragraph.text_frame_ov_val(prs, slide, shape, "TextBox 87")
         frame = ov_val_04.paragraphs[0]
         run = frame.add_run()
@@ -76,7 +76,7 @@ def overview(prs):
         font = run.font
         font = Paragraph.text_style_ov_val(prs, font)
 
-        # Overeview Value - Credentials exposed in recent posts
+        # Overview Value - Credentials exposed in recent posts
         ov_val_05 = Paragraph.text_frame_ov_val(prs, slide, shape, "TextBox 90")
         frame = ov_val_05.paragraphs[0]
         run = frame.add_run()

src/pe_reports/report_generator.py

@@ -1,4 +1,4 @@
-"""ciagov/pe-reports: A tool for creating Posture & Exposure reports."""
+"""A tool for creating Posture & Exposure reports."""
 
 # Standard Python Libraries
 import os

src/pe_reports/stylesheet.py

@@ -1,4 +1,4 @@
-"""Models to manage grahical attributes of presentation layouts, paragraphs, and charts."""
+"""Models to manage graphical attributes of presentation layouts, paragraphs, and charts."""
 
 # Third-Party Libraries
 from pptx.dml.color import RGBColor
@@ -7,7 +7,7 @@
 
 
 class Paragraph:
-    """Simple class to call text frame atributes."""
+    """Simple class to call text frame attributes."""
 
     def shapes(self, slide):
         """Create a text frame."""
@@ -52,7 +52,7 @@ def text_style_title(self, font):
         return font
 
     def text_style_key_metric(self, font):
-        """Need to insert docstring here."""
+        """Text style for key metrics."""
         font.name = "Calibri"
         font.size = Pt(12)
         font.color.rgb = RGBColor(255, 255, 255)

tests/test_pe_reports.py

@@ -3,6 +3,8 @@
 # Standard Python Libraries
 import unittest
 
+# TODO: Replace current dummy test with useful tests - https://github.com/cisagov/pe-reports/issues/3#issue-909531010
+
 
 class TestingStringMethods(unittest.TestCase):
     """Simple test for first-commit only."""
@@ -17,8 +19,6 @@ def test_string_case(self):
         # if both arguments are equal then it's success
         self.assertEqual("tutorialspoint".upper(), "TUTORIALSPOINT")
 
-    # checking whether a string is upper or not
-
     def test_is_string_upper(self):
         """Checks whether a string is upper or not."""
         # used to check whether the statement is True or False