Apply suggestions from code review

Co-authored-by: Lukas Heumos <lukas.heumos@posteo.net>

Author: grst

.github/workflows/make-json.yml

@@ -20,7 +20,7 @@ jobs:
         uses: astral-sh/setup-uv@v7
         with:
           cache-dependency-glob: scripts/pyproject.toml
-      - name: Excecute validation script and create output directory
+      - name: Execute validation script and create output directory
         run: |
           uvx --from ./scripts validate-registry --registry-dir packages --outdir=build
         env:

scripts/src/ecosystem_scripts/schema.json

@@ -207,7 +207,7 @@
             "type": "string"
         },
         "contact": {
-            "description": "Point of contact for this package. This does not need to be the full list of maintainers, but whoever feels responsible for this metadata entry and serves as a point of contact for scverse. Entries must be Github user IDs.",
+            "description": "Point of contact for this package. Does not need to be the full list of maintainers. Entries must be Github user IDs.",
             "type": "array",
             "items": {
                 "type": "string"
@@ -216,7 +216,7 @@
             "uniqueItems": true
         },
         "logo": {
-            "description": "Path to the logo (relative to meta.yaml). Should be either logo.png, logo.webp, or logo.svg. In case of a PNG image, it must fit in a bounding box of 512x512px and one dimention must be exactly 512px.",
+            "description": "Path to the logo (relative to meta.yaml). Should be either logo.png, logo.webp, or logo.svg. In case of a PNG image, it must fit in a bounding box of 512x512px and one dimension must be exactly 512px.",
             "type": "string",
             "pattern": "logo\\.(svg|png|webp)"
         },

scripts/src/ecosystem_scripts/validate_registry.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-"""Valididate packages' meta.yaml and generate an output directory with json/images to be uploaded on github pages"""
+"""Validate packages' meta.yaml and generate an output directory with json/images to be uploaded on Github Pages"""
 
 from __future__ import annotations
 
@@ -63,7 +63,7 @@ def check_and_register(self, url: str, context: str) -> None:
 
 
 class GitHubUserValidator:
-    """Validate GitHub usernames against the GitHub API."""
+    """Validate GitHub usernames using the GitHub API."""
 
     def __init__(self, github_token: str | None = None):
         self.github_token = github_token
@@ -79,7 +79,6 @@ def validate_username(self, username: str, context: str) -> None:
         context
             Context information for error messages (e.g., file being validated)
         """
-        # Skip if already validated
         if username in self.validated_users:
             return
 
@@ -116,7 +115,6 @@ def validate_package(self, package_name: str, context: str) -> None:
         context
             Context information for error messages (e.g., file being validated)
         """
-        # Skip if already validated
         if package_name in self.validated_packages:
             return
 
@@ -134,7 +132,7 @@ def validate_package(self, package_name: str, context: str) -> None:
 
 
 class CondaValidator:
-    """Validate Conda package identifiers against the Anaconda API."""
+    """Validate Conda package identifiers using the Anaconda API."""
 
     def __init__(self):
         self.validated_packages: set[str] = set()
@@ -149,7 +147,6 @@ def validate_package(self, package_spec: str, context: str) -> None:
         context
             Context information for error messages (e.g., file being validated)
         """
-        # Skip if already validated
         if package_spec in self.validated_packages:
             return
 
@@ -178,7 +175,7 @@ def validate_package(self, package_spec: str, context: str) -> None:
 
 
 class CRANValidator:
-    """Validate CRAN package names against the CRAN API."""
+    """Validate CRAN package names using the CRAN API."""
 
     def __init__(self):
         self.validated_packages: set[str] = set()
@@ -193,7 +190,6 @@ def validate_package(self, package_name: str, context: str) -> None:
         context
             Context information for error messages (e.g., file being validated)
         """
-        # Skip if already validated
         if package_name in self.validated_packages:
             return
 
@@ -215,7 +211,7 @@ def validate_package(self, package_name: str, context: str) -> None:
 
 
 def _check_image(img_path: Path) -> None:
-    """Check that the image exists and that it is either SVG or fits into the 512x512 bounding box."""
+    """Validates that the image exists and that it is either a SVG or fits into the 512x512 bounding box."""
     if not img_path.exists():
         msg = f"Image does not exist: {img_path}"
         raise ValueError(msg)