Skip to content

Commit 67433e1

Browse files
committed
Improve Network.ListReferences() documentation
1 parent 1ca809d commit 67433e1

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

LibGit2Sharp/Network.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ public virtual RemoteCollection Remotes
5454

5555
/// <summary>
5656
/// List references in a <see cref="Remote"/> repository.
57+
/// <para>
58+
/// When the remote tips are ahead of the local ones, the retrieved
59+
/// <see cref="DirectReference"/>s may point to non existing
60+
/// <see cref="GitObject"/>s in the local repository. In that
61+
/// case, <see cref="DirectReference.Target"/> will return <c>null</c>.
62+
/// </para>
5763
/// </summary>
5864
/// <param name="remote">The <see cref="Remote"/> to list from.</param>
5965
/// <returns>The references in the <see cref="Remote"/> repository.</returns>

0 commit comments

Comments
 (0)