updating docstrings based on comments in PR

bandophahita · Jan 15, 2024 · 5a1ac15 · 5a1ac15
1 parent 3f3a997
commit 5a1ac15
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/screenpy_selenium/actions/hold_down.py b/screenpy_selenium/actions/hold_down.py
@@ -44,7 +44,7 @@ class HoldDown:
     @classmethod
     def command_or_control_key(cls: Type[SelfHoldDown]) -> SelfHoldDown:
         """
-        A convenience method.
+        A convenience method for supporting multiple operating systems.
 
         Figures out what operating system the Actor is using and directs the Actor
         which execution key to hold down.

diff --git a/screenpy_selenium/actions/release.py b/screenpy_selenium/actions/release.py
@@ -41,7 +41,7 @@ class Release:
     @classmethod
     def command_or_control_key(cls: Type[SelfRelease]) -> SelfRelease:
         """
-        A convenience method.
+        A convenience method for supporting multiple operating systems.
 
         Figures out what operating system the Actor is using and tells the Actor which
         execution key to release.

diff --git a/screenpy_selenium/target.py b/screenpy_selenium/target.py
@@ -127,11 +127,11 @@ def __repr__(self: SelfTarget) -> str:
     __str__ = __repr__
 
     def __iter__(self: SelfTarget) -> Iterator[str]:
-        """Interator."""
+        """Allow Targets to be treated as ``(By, str)`` tuples."""
         return self.get_locator().__iter__()
 
     def __getitem__(self: SelfTarget, index: int) -> str:
-        """Allow slicing of target name directly."""
+        """Allow Targets to be treated as ``(By, str)`` tuples."""
         return self.get_locator()[index]
 
     def __init__(