document UnidocDatabase.package(named:with:) and realm(named:with:)

Author: tayloraswift

Sources/UnidocQueries/UnidocDatabase (ext).swift

@@ -5,6 +5,8 @@ import UnidocRecords
 
 extension UnidocDatabase
 {
+    /// Load the metadata for a package by name. The returned package might have a different
+    /// canonical name than the one provided.
     public
     func package(named symbol:Symbol.Package,
         with session:Mongo.Session) async throws -> Unidoc.PackageMetadata?
@@ -13,6 +15,8 @@ extension UnidocDatabase
             query: Unidoc.AliasResolutionQuery<PackageAliases, Packages>.init(symbol: symbol),
             with: session)
     }
+    /// Load the metadata for a realm by name. The returned realm might have a different
+    /// canonical name than the one provided.
     public
     func realm(named symbol:String,
         with session:Mongo.Session) async throws -> Unidoc.RealmMetadata?