Skip to content

Commit

Permalink
chore: use #: for class property docs
Browse files Browse the repository at this point in the history
Signed-off-by: Mohammad Abdollahpour <[email protected]>
  • Loading branch information
mabdollahpour-ol committed Oct 2, 2024
1 parent 4864b0b commit a2cba60
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions src/macaron/repo_verifier/repo_verifier_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,22 +60,27 @@ def find_file_in_repo(root_dir: Path, filename: str) -> Path | None:
class RepositoryVerificationStatus(str, Enum):
"""A class to store the status of the repo verification."""

# We found evidence to prove that the repository can be linked back to the publisher of the artifact.
#: We found evidence to prove that the repository can be linked back to the publisher of the artifact.
PASSED = "passed"

# We found evidence showing that the repository is not the publisher of the artifact.
#: We found evidence showing that the repository is not the publisher of the artifact.
FAILED = "failed"

# We could not find any evidence to prove or disprove that the repository can be linked back to the artifact.
#: We could not find any evidence to prove or disprove that the repository can be linked back to the artifact.
UNKNOWN = "unknown"


@dataclass(frozen=True)
class RepositoryVerificationResult:
"""A class to store the information about repository verification."""

#: The status of the repository verification.
status: RepositoryVerificationStatus

#: The reason for the verification result.
reason: str

#: The build tool used to build the package.
build_tool: BaseBuildTool


Expand Down

0 comments on commit a2cba60

Please sign in to comment.