RepoAuditor 0.2.16__tar.gz → 0.2.18__tar.gz

{repoauditor-0.2.16 → repoauditor-0.2.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.16
+Version: 0.2.18
 Summary: Add your description here
 Project-URL: Homepage, https://github.com/gt-sse-center/RepoAuditor
 Project-URL: Documentation, https://github.com/gt-sse-center/RepoAuditor

{repoauditor-0.2.16 → repoauditor-0.2.18}/pyproject.toml

@@ -111,7 +111,7 @@ select = [
     "SLF",
     "SIM",
     "SLOT",
-    # "TID", # 9
+    "TID",
     "TD",
     "TC",
     "ARG",
@@ -126,7 +126,7 @@ select = [
     "E",
     "W",
     "DOC",
-    # "D", # 249
+    "D",
     "F",
     "PGH",
     # "PL", # 11
@@ -142,6 +142,9 @@ ignore = [
     "ANN003", # Missing type annotation for `**kwargs`
     "BLE001", # Do not catch blind exception: `Exception`
     "COM812", # Trailing comma missing
+    "D104", # Missing docstring in public package
+    "D106", # Missing docstring in public nested class
+    "D107", # Missing docstring in `__init__` method
     "D202", # No blank lines allowed after function docstring
     "E501", # Line too long
     "I001", # Import block is un-sorted or un-formatted

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/CommandLineProcessor.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the CommandLineProcessor object"""
+"""Contains the CommandLineProcessor object."""
 
 from dataclasses import dataclass, field
 from typing import Any, Protocol
@@ -17,7 +17,8 @@ from .ExecuteModules import Execute, Module, ModuleInfo
 # ----------------------------------------------------------------------
 @dataclass(frozen=True)
 class CommandLineProcessor:
-    """\
+    """Class for processing command line arguments and invoking the appropriate modules.
+
     Object that makes it easy to process command line arguments and invoke ExecuteModules.Execute
     in a testable way.
     """
@@ -28,7 +29,7 @@ class CommandLineProcessor:
     # |
     # ----------------------------------------------------------------------
     class GetDynamicArgsFunc(Protocol):
-        def __call__(
+        def __call__(  # noqa: D102
             self,
             dynamic_arg_definitions: dict[
                 str, Any
@@ -65,6 +66,7 @@ class CommandLineProcessor:
         single_threaded: bool = False,
         argument_separator: str = "-",
     ) -> "CommandLineProcessor":
+        """Factor method to construct a CommandLineProcessor object."""
         # Convert modules into a lookup map
         module_map: dict[str, Module] = {}
 
@@ -199,7 +201,7 @@ class CommandLineProcessor:
         )
 
     # ----------------------------------------------------------------------
-    def __call__(
+    def __call__(  # noqa: D102
         self,
         dm: DoneManager,
     ) -> list[list[Module.EvaluateInfo]]:

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/EntryPoint.py

@@ -33,8 +33,11 @@ ARGUMENT_SEPARATOR = "-"
 
 # ----------------------------------------------------------------------
 class NaturalOrderGrouper(TyperGroup):
+    """Group commands in natural order."""
+
     # ----------------------------------------------------------------------
     def list_commands(self, *args, **kwargs) -> list[str]:  # noqa: ARG002
+        """Return a list of all the commands, to be sorted in a natural ordering."""
         return self.commands.keys()
 
 
@@ -257,6 +260,7 @@ def EntryPoint(
         ),
     ] = False,
 ) -> None:
+    """Entry point for the command line interface."""
     with DoneManager.CreateCommandLine(
         sys.stdout,
         flags=DoneManagerFlags.Create(verbose=verbose, debug=debug),

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/ExecuteModules.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains functionality to execute multiple Modules"""
+"""Contains functionality to execute multiple Modules."""
 
 import itertools
 import sys
@@ -34,6 +34,8 @@ from .Module import EvaluateResult, ExecutionStyle, Module, OnStatusFunc
 # ----------------------------------------------------------------------
 @dataclass(frozen=True)
 class ModuleInfo:
+    """Information about a Module."""
+
     module: Module
     dynamic_args: dict[str, Any]
     requirement_args: dict[str, Any]
@@ -52,6 +54,7 @@ def Execute(
     *,
     single_threaded: bool = False,
 ) -> list[list[Module.EvaluateInfo]]:
+    """Execute the modules in parallel and/or sequentially."""
     if not module_infos:
         dm.WriteWarning("There are no modules to process.\n")
         return []
@@ -266,6 +269,7 @@ def DisplayResults(
     display_rationale: bool,
     panel_width: Optional[int] = None,
 ) -> None:
+    """Display the results of executing the modules."""
     for results in all_results:
         assert results
         module = results[0].module

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Impl/ParallelSequentialProcessor.py

@@ -35,6 +35,7 @@ def ParallelSequentialProcessor(
     *,
     max_num_threads: Optional[int] = None,
 ) -> list[OutputType]:
+    """Process a list of items in parallel and/or sequentially."""
     if dm is None:
         with DoneManager.Create(StreamDecorator(None), "", line_prefix="") as dm:
             return _Impl(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Module.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the Module object and types used in its definition"""
+"""Contains the Module object and types used in its definition."""
 
 import threading
 
@@ -55,6 +55,7 @@ class Module(ABC):
 
     # ----------------------------------------------------------------------
     def GetNumRequirements(self) -> int:
+        """Get the total number of requirements across all queries."""
         return sum(len(query.requirements) for query in self.queries)
 
     # ----------------------------------------------------------------------
@@ -63,6 +64,7 @@ class Module(ABC):
         included_names: set[str],
         excluded_names: set[str],
     ) -> None:
+        """Process the requirements to remove invalid requirements and queries."""
         query_index = 0
 
         while query_index < len(self.queries):
@@ -90,7 +92,7 @@ class Module(ABC):
     # ----------------------------------------------------------------------
     @abstractmethod
     def GetDynamicArgDefinitions(self) -> dict[str, TypeDefinitionItemType]:
-        """Returns information about dynamic arguments that the module can consume (often from the command line)."""
+        """Return information about dynamic arguments that the module can consume (often from the command line)."""
 
         raise NotImplementedError("Abstract method")  # pragma: no cover # noqa: EM101
 
@@ -100,8 +102,7 @@ class Module(ABC):
         self,
         dynamic_args: dict[str, Any],
     ) -> Optional[dict[str, Any]]:
-        """\
-        Augments data beyond data initially encountered (for example, on the command line).
+        """Augments data beyond data initially encountered (for example, on the command line).
 
         Return None to indicate that the Module cannot be evaluated. Raise an
         exception to indicate that the command line data is invalid.
@@ -118,6 +119,7 @@ class Module(ABC):
         *,
         max_num_threads: Optional[int] = None,
     ) -> list[list["Module.EvaluateInfo"]]:
+        """Evaluate the module using the module data and requirement data."""
         status_info = StatusInfo()
         status_info_lock = threading.Lock()
 

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugin.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the interface that Plugins must implement"""
+"""Contains the interface that Plugins must implement."""
 
 import pluggy
 
@@ -16,5 +16,5 @@ from .Module import Module
 # ----------------------------------------------------------------------
 @pluggy.HookspecMarker(APP_NAME)
 def GetModule() -> Module:
-    """Returns a Module"""
+    """Return a Module."""
     raise NotImplementedError("hookspec")  # pragma: no cover # noqa: EM101

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionQuery.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the ClassicBranchProtection object"""
+"""Contains the ClassicBranchProtection object."""
 
 from typing import Any, Optional
 
@@ -117,6 +117,7 @@ class ClassicBranchProtectionQuery(Query):
         self,
         module_data: dict[str, Any],
     ) -> Optional[dict[str, Any]]:
+        """Get the data from an API session."""
         branch = module_data.get("branch")
         if branch is None:
             # Get the default branch name

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/AllowDeletions.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the AllowDeletions object"""
+"""Contains the AllowDeletions object."""
 
 import textwrap
 
@@ -13,6 +13,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class AllowDeletions(ClassicEnableRequirementImpl):
+    """Allow deletion of the mainline branch."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/AllowForcePushes.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the AllowForcePushes object"""
+"""Contains the AllowForcePushes object."""
 
 import textwrap
 
@@ -13,6 +13,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class AllowForcePushes(ClassicEnableRequirementImpl):
+    """Allow force pushes to the mainline branch."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/DismissStalePullRequestApprovals.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the DismissStalePullRequestApprovals object"""
+"""Contains the DismissStalePullRequestApprovals object."""
 
 import textwrap
 
@@ -15,6 +15,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class DismissStalePullRequestApprovals(ClassicEnableRequirementImpl):
+    """Dismiss stale pull request approvals when new commits are pushed."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/DoNotAllowBypassSettings.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the AllowBypassSettings object"""
+"""Contains the AllowBypassSettings object."""
 
 import textwrap
 
@@ -13,6 +13,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class DoNotAllowBypassSettings(ClassicEnableRequirementImpl):
+    """Do not allow bypassing settings."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/EnsureStatusChecks.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the EnsureStatusChecks object"""
+"""Contains the EnsureStatusChecks object."""
 
 import textwrap
 
@@ -19,6 +19,8 @@ from RepoAuditor.Requirement import EvaluateResult, ExecutionStyle, Requirement
 
 # ----------------------------------------------------------------------
 class EnsureStatusChecks(Requirement):
+    """Ensure that status checks have been enabled for the branch."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(
@@ -54,6 +56,7 @@ class EnsureStatusChecks(Requirement):
     # ----------------------------------------------------------------------
     @override
     def GetDynamicArgDefinitions(self) -> dict[str, TypeDefinitionItemType]:
+        """Get the definitions for the arguments to this requirement."""
         return {
             "disable": (
                 bool,

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/Impl/ClassicEnableRequirementImpl.py

@@ -4,18 +4,20 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the ClassicEnableRequirementImpl object"""
+"""Contains the ClassicEnableRequirementImpl object."""
 
 import textwrap
 
 from typing import Any, Optional
 from collections.abc import Callable
 
-from ...Impl.EnableRequirementImpl import EnableRequirementImpl
+from RepoAuditor.Plugins.GitHub.Impl.EnableRequirementImpl import EnableRequirementImpl
 
 
 # ----------------------------------------------------------------------
 class ClassicEnableRequirementImpl(EnableRequirementImpl):
+    """Implementation of a requirement that checks a classical setting is enabled."""
+
     # ----------------------------------------------------------------------
     def __init__(
         self,

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/Impl/ClassicValueRequirementImpl.py

@@ -4,18 +4,20 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the ClassicValueRequirementImpl object"""
+"""Contains the ClassicValueRequirementImpl object."""
 
 import textwrap
 
 from typing import Any, Optional
 from collections.abc import Callable
 
-from ...Impl.ValueRequirementImpl import DoesNotApplyResult, ValueRequirementImpl
+from RepoAuditor.Plugins.GitHub.Impl.ValueRequirementImpl import DoesNotApplyResult, ValueRequirementImpl
 
 
 # ----------------------------------------------------------------------
 class ClassicValueRequirementImpl(ValueRequirementImpl):
+    """Implementation of a requirement that checks a classic value in GitHub settings."""
+
     # ----------------------------------------------------------------------
     def __init__(
         self,

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireApprovalMostRecentPush.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the RequireApprovalMostRecentPush object"""
+"""Contains the RequireApprovalMostRecentPush object."""
 
 import textwrap
 
@@ -15,6 +15,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class RequireApprovalMostRecentPush(ClassicEnableRequirementImpl):
+    """Require approval of the most recent reviewable push."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireApprovals.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the RequireApprovals object"""
+"""Contains the RequireApprovals object."""
 
 import textwrap
 
@@ -15,6 +15,8 @@ from .Impl.ClassicValueRequirementImpl import ClassicValueRequirementImpl, DoesN
 
 # ----------------------------------------------------------------------
 class RequireApprovals(ClassicValueRequirementImpl):
+    """Require approvals for pull requests."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireCodeOwnerReview.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the RequireCodeOwnerReview object"""
+"""Contains the RequireCodeOwnerReview object."""
 
 import textwrap
 
@@ -15,6 +15,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class RequireCodeOwnerReview(ClassicEnableRequirementImpl):
+    """Requirement of review from code owners."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireConversationResolution.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the RequireConversationResolution object"""
+"""Contains the RequireConversationResolution object."""
 
 import textwrap
 
@@ -13,6 +13,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class RequireConversationResolution(ClassicEnableRequirementImpl):
+    """Require conversation resolution before merging."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireLinearHistory.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the RequireLinearHistory object"""
+"""Contains the RequireLinearHistory object."""
 
 import textwrap
 
@@ -13,6 +13,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class RequireLinearHistory(ClassicEnableRequirementImpl):
+    """Require a linear history."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequirePullRequests.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the RequirePullRequests object"""
+"""Contains the RequirePullRequests object."""
 
 import textwrap
 
@@ -13,6 +13,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class RequirePullRequests(ClassicEnableRequirementImpl):
+    """Require a pull request before merging."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireSignedCommits.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the RequireSignedCommits object"""
+"""Contains the RequireSignedCommits object."""
 
 import textwrap
 
@@ -13,6 +13,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class RequireSignedCommits(ClassicEnableRequirementImpl):
+    """Require signed commits."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireStatusChecksToPass.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the RequireStatusChecksToPass object"""
+"""Contains the RequireStatusChecksToPass object."""
 
 import textwrap
 
@@ -13,6 +13,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class RequireStatusChecksToPass(ClassicEnableRequirementImpl):
+    """Require status checks to pass before merging pull requests."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireUpToDateBranches.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the RequireUpToDateBranches object"""
+"""Contains the RequireUpToDateBranches object."""
 
 import textwrap
 
@@ -15,6 +15,8 @@ from .Impl.ClassicEnableRequirementImpl import ClassicEnableRequirementImpl
 
 # ----------------------------------------------------------------------
 class RequireUpToDateBranches(ClassicEnableRequirementImpl):
+    """Require branches to be up to date before merging."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/DefaultBranchQuery.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the DefaultBranchQuery object"""
+"""Contains the DefaultBranchQuery object."""
 
 from typing import Any, Optional
 
@@ -35,6 +35,7 @@ class DefaultBranchQuery(Query):
         self,
         module_data: dict[str, Any],
     ) -> Optional[dict[str, Any]]:
+        """Get the data from an API session."""
         # Get the default branch name
         response = module_data["session"].get("")
 

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/DefaultBranchQueryRequirements/Protected.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the Protected object"""
+"""Contains the Protected object."""
 
 import textwrap
 
@@ -14,13 +14,14 @@ import typer
 
 from dbrownell_Common.TyperEx import TypeDefinitionItemType  # type: ignore[import-untyped]
 from dbrownell_Common.Types import override  # type: ignore[import-untyped]
+from RepoAuditor.Plugins.GitHub.Impl.Common import CreateIncompleteDataResult
 from RepoAuditor.Requirement import EvaluateResult, ExecutionStyle, Requirement
 
-from ..Impl.Common import CreateIncompleteDataResult
-
 
 # ----------------------------------------------------------------------
 class Protected(Requirement):
+    """Requirement to ensure that the mainline branch is protected."""
+
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         # Note that protected is set for the branch when creating a branch ruleset or a classic
@@ -54,6 +55,7 @@ class Protected(Requirement):
     # ----------------------------------------------------------------------
     @override
     def GetDynamicArgDefinitions(self) -> dict[str, TypeDefinitionItemType]:
+        """Get the definitions for the arguments to this requirement."""
         return {
             "false": (
                 bool,

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/Impl/Common.py

@@ -11,6 +11,7 @@ from RepoAuditor.Requirement import EvaluateResult, Requirement
 
 # ----------------------------------------------------------------------
 def CreateIncompleteDataResult() -> Requirement.EvaluateImplResult:
+    """Create an incomplete data result."""
     return Requirement.EvaluateImplResult(
         EvaluateResult.Warning,
         "Incomplete data was encountered; please provide the GitHub PAT or update the PAT's permissions if one was provided.",

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/Impl/EnableRequirementImpl.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the EnableRequirementImpl object"""
+"""Contains the EnableRequirementImpl object."""
 
 from typing import Any, Optional
 from collections.abc import Callable
@@ -63,6 +63,7 @@ class EnableRequirementImpl(Requirement):
     # ----------------------------------------------------------------------
     @override
     def GetDynamicArgDefinitions(self) -> dict[str, TypeDefinitionItemType]:
+        """Get the definitions for the arguments to this requirement."""
         return {
             self.dynamic_arg_name: (
                 bool,

{repoauditor-0.2.16 → repoauditor-0.2.18}/src/RepoAuditor/Plugins/GitHub/Impl/ValueRequirementImpl.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the ValueRequirementImpl object"""
+"""Contains the ValueRequirementImpl object."""
 
 from dataclasses import dataclass
 from typing import Any, Optional
@@ -71,6 +71,7 @@ class ValueRequirementImpl(Requirement):
     # ----------------------------------------------------------------------
     @override
     def GetDynamicArgDefinitions(self) -> dict[str, TypeDefinitionItemType]:
+        """Get the definitions for the arguments to this requirement."""
         return {
             "value": (
                 str,