Fix comment, add check for null

NuGet · Nov 6, 2024 · e7e1397 · e7e1397
1 parent c8917d7
commit e7e1397
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/src/NuGet.Core/NuGet.Protocol/Resources/PackageMetadataResourceV3.cs b/src/NuGet.Core/NuGet.Protocol/Resources/PackageMetadataResourceV3.cs
@@ -280,7 +280,10 @@ private void ProcessRegistrationPage(
                 {
                     catalogEntry.ReportAbuseUrl = _reportAbuseResource?.GetReportAbuseUrl(catalogEntry.PackageId, catalogEntry.Version);
                     catalogEntry.PackageDetailsUrl = _packageDetailsUriResource?.GetUri(catalogEntry.PackageId, catalogEntry.Version);
-                    catalogEntry.ReadmeFileUrl = _readmeUriTemplateResource?.GetReadmeUrl(catalogEntry.PackageId, catalogEntry.Version);
+                    if (string.IsNullOrWhiteSpace(catalogEntry.ReadmeFileUrl))
+                    {
+                        catalogEntry.ReadmeFileUrl = _readmeUriTemplateResource?.GetReadmeUrl(catalogEntry.PackageId, catalogEntry.Version);
+                    }
                     catalogEntry = metadataCache.GetObject(catalogEntry);
                     results.Add(catalogEntry);
                 }

diff --git a/src/NuGet.Core/NuGet.Protocol/Resources/ReadmeUriTemplateResource.cs b/src/NuGet.Core/NuGet.Protocol/Resources/ReadmeUriTemplateResource.cs
@@ -20,11 +20,11 @@ public ReadmeUriTemplateResource(string uriTemplate)
         }
 
         /// <summary>
-        /// Gets a URL for reporting package abuse. The URL will not be verified to exist.
+        /// Get  the URL for downloading the readme file.
         /// </summary>
-        /// <param name="id">The package id (natural casing)</param>
+        /// <param name="id">The package id</param>
         /// <param name="version">The package version</param>
-        /// <returns>The first URL from the resource, with the URI template applied.</returns>
+        /// <returns>URL to download README, built using the URI template.</returns>
         public string GetReadmeUrl(string id, NuGetVersion version)
         {
             if (_uriTemplate == null)