Skip to content

Commit 5ce72e4

Browse files
committed
[GH Usage] Added contextual information about the result of a func call
1 parent b24d6ca commit 5ce72e4

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

src/NuGetGallery.Core/GitHub/IGitHubUsageConfiguration.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ namespace NuGetGallery
66
public interface IGitHubUsageConfiguration
77
{
88
/// <summary>
9-
/// Returns a NuGetPackageGitHubInformation object that contains the information about a NuGet package.
9+
/// Returns the GitHub dependants information about a NuGet package.
10+
///
1011
/// If a packageId has no information, the NuGetPackageGitHubInformation's TotalRepos will be 0
1112
/// and the Repos list will be empty
1213
///
1314
/// </summary>
1415
/// <exception cref="System.ArgumentNullException">Thrown when packageId is null</exception>
1516
/// <param name="packageId">NuGet package id, cannot be null</param>
16-
/// <returns></returns>
17+
/// <returns>NuGetPackageGitHubInformation that contains the information about a NuGet package.</returns>
1718
NuGetPackageGitHubInformation GetPackageInformation(string packageId);
1819
}
1920
}

0 commit comments

Comments
 (0)