From c2a995755ccf2b3d9c4801072a7b97b3af34aa6a Mon Sep 17 00:00:00 2001
From: Gang Li <ligangty@users.noreply.github.com>
Date: Tue, 24 Sep 2024 16:19:15 +0800
Subject: [PATCH] chore: fixed a api doc and added some comments

---
 charon/pkgs/maven.py | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/charon/pkgs/maven.py b/charon/pkgs/maven.py
index f93d7ba..3c3954d 100644
--- a/charon/pkgs/maven.py
+++ b/charon/pkgs/maven.py
@@ -996,8 +996,8 @@ def _generate_metadatas(
        what we should do here is:
        * Scan and get the GA for the poms
        * Search all poms in s3 based on the GA
-       * Use searched poms and scanned poms to generate
-         maven-metadata to refresh
+       * Use searched pomsto generate maven-metadata
+         to refresh
     """
     ga_dict: Dict[str, bool] = {}
     logger.debug("Valid poms: %s", poms)
@@ -1007,6 +1007,8 @@ def _generate_metadatas(
             logger.debug("G: %s, A: %s", g, a)
             g_path = "/".join(g.split("."))
             ga_dict[os.path.join(g_path, a)] = True
+    # Note: here we don't need to add original poms, because
+    # they have already been uploaded to s3.
     all_poms = []
     meta_files = {}
     for path, _ in ga_dict.items():