Detailed doc string on /package/{name}.json

haskell · Nov 22, 2024 · aff02c2 · aff02c2
1 parent 5b0d3b0
commit aff02c2
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/Distribution/Server/Features/PackageInfoJSON.hs b/src/Distribution/Server/Features/PackageInfoJSON.hs
@@ -85,7 +85,9 @@ initPackageInfoJSONFeature env = do
   return $ \core preferred -> do
 
     let coreR = coreResource core
-        info = "Get basic package information"
+        info = "Get basic package information: \
+               \The response contains a JSON object where the keys are version numbers as strings, \
+               \and the values are whether the version is preferred or not"
         vInfo = "Get basic package information at a specific metadata revision"
 
         jsonResources = [