add a comment

fossas · Sep 3, 2024 · 70daff0 · 70daff0
1 parent c386165
commit 70daff0
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/Srclib/Types.hs b/src/Srclib/Types.hs
@@ -411,6 +411,7 @@ renderLocator :: Locator -> Text
 renderLocator Locator{..} =
  locatorFetcher <> "+" <> locatorProject <> "$" <> fromMaybe "" locatorRevision
 
+-- The projectId is the full locator of the project. E.g. custom+123/someProject (<fetcher>+<orgId>/<project-name>)
 projectId :: Locator -> Text
 projectId Locator{..} =
  locatorFetcher <> "+" <> locatorProject