Skip to content

Commit 995886d

Browse files
docs(audience): document BuildPayload null return contract
Addresses review feedback on PR #691. Makes the nullable return value explicit in the XML doc — the reviewer asked for Passport-style clarity on what's nullable. Enabling nullable reference types package-wide is a larger follow-up; this commit covers the specific case flagged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 9985194 commit 995886d

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

src/Packages/Audience/Runtime/Transport/HttpTransport.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,12 @@ private void ResetBackoff()
176176
/// <summary>
177177
/// Reads file contents for each path and builds the batch JSON payload:
178178
/// <c>{"batch":[msg1,msg2,...]}</c>
179-
/// Returns null if no files could be read.
180179
/// </summary>
180+
/// <returns>
181+
/// The batch JSON string, or <c>null</c> when every path failed to read
182+
/// (files disappeared, empty, or locked). The caller treats <c>null</c>
183+
/// as "nothing to send" and deletes the path list.
184+
/// </returns>
181185
private static string BuildPayload(IReadOnlyList<string> paths)
182186
{
183187
var sb = new StringBuilder("{\"batch\":[");

0 commit comments

Comments
 (0)