Skip to content

Commit 4a1601b

Browse files
authored
[api] Fix Baggage XML documentation (#5562)
1 parent f76d21a commit 4a1601b

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/OpenTelemetry.Api/Baggage.cs

+10-10
Original file line numberDiff line numberDiff line change
@@ -157,11 +157,11 @@ public static Baggage SetBaggage(string name, string value, Baggage baggage = de
157157
}
158158

159159
/// <summary>
160-
/// Returns a new <see cref="Baggage"/> which contains the new key/value pair.
160+
/// Returns a new <see cref="Baggage"/> which contains the new key/value pairs.
161161
/// </summary>
162162
/// <param name="baggageItems">Baggage key/value pairs.</param>
163163
/// <param name="baggage">Optional <see cref="Baggage"/>. <see cref="Current"/> is used if not specified.</param>
164-
/// <returns>New <see cref="Baggage"/> containing the key/value pair.</returns>
164+
/// <returns>New <see cref="Baggage"/> containing the new key/value pairs.</returns>
165165
/// <remarks>Note: The <see cref="Baggage"/> returned will be set as the new <see cref="Current"/> instance.</remarks>
166166
[SuppressMessage("roslyn", "RS0026", Justification = "TODO: fix APIs that violate the backcompt requirement - multiple overloads with optional parameters: https://github.com/dotnet/roslyn/blob/main/docs/Adding%20Optional%20Parameters%20in%20Public%20API.md.")]
167167
public static Baggage SetBaggage(IEnumerable<KeyValuePair<string, string>> baggageItems, Baggage baggage = default)
@@ -180,7 +180,7 @@ public static Baggage SetBaggage(IEnumerable<KeyValuePair<string, string>> bagga
180180
/// </summary>
181181
/// <param name="name">Baggage item name.</param>
182182
/// <param name="baggage">Optional <see cref="Baggage"/>. <see cref="Current"/> is used if not specified.</param>
183-
/// <returns>New <see cref="Baggage"/> containing the key/value pair.</returns>
183+
/// <returns>New <see cref="Baggage"/> with the key/value pair removed.</returns>
184184
/// <remarks>Note: The <see cref="Baggage"/> returned will be set as the new <see cref="Current"/> instance.</remarks>
185185
public static Baggage RemoveBaggage(string name, Baggage baggage = default)
186186
{
@@ -197,7 +197,7 @@ public static Baggage RemoveBaggage(string name, Baggage baggage = default)
197197
/// Returns a new <see cref="Baggage"/> with all the key/value pairs removed.
198198
/// </summary>
199199
/// <param name="baggage">Optional <see cref="Baggage"/>. <see cref="Current"/> is used if not specified.</param>
200-
/// <returns>New <see cref="Baggage"/> containing the key/value pair.</returns>
200+
/// <returns>New <see cref="Baggage"/> with all the key/value pairs removed.</returns>
201201
/// <remarks>Note: The <see cref="Baggage"/> returned will be set as the new <see cref="Current"/> instance.</remarks>
202202
public static Baggage ClearBaggage(Baggage baggage = default)
203203
{
@@ -252,18 +252,18 @@ public Baggage SetBaggage(string name, string value)
252252
}
253253

254254
/// <summary>
255-
/// Returns a new <see cref="Baggage"/> which contains the new key/value pair.
255+
/// Returns a new <see cref="Baggage"/> which contains the new key/value pairs.
256256
/// </summary>
257257
/// <param name="baggageItems">Baggage key/value pairs.</param>
258-
/// <returns>New <see cref="Baggage"/> containing the key/value pair.</returns>
258+
/// <returns>New <see cref="Baggage"/> containing the key/value pairs.</returns>
259259
public Baggage SetBaggage(params KeyValuePair<string, string>[] baggageItems)
260260
=> this.SetBaggage((IEnumerable<KeyValuePair<string, string>>)baggageItems);
261261

262262
/// <summary>
263-
/// Returns a new <see cref="Baggage"/> which contains the new key/value pair.
263+
/// Returns a new <see cref="Baggage"/> which contains the new key/value pairs.
264264
/// </summary>
265265
/// <param name="baggageItems">Baggage key/value pairs.</param>
266-
/// <returns>New <see cref="Baggage"/> containing the key/value pair.</returns>
266+
/// <returns>New <see cref="Baggage"/> containing the key/value pairs.</returns>
267267
public Baggage SetBaggage(IEnumerable<KeyValuePair<string, string>> baggageItems)
268268
{
269269
if (baggageItems?.Any() != true)
@@ -292,7 +292,7 @@ public Baggage SetBaggage(IEnumerable<KeyValuePair<string, string>> baggageItems
292292
/// Returns a new <see cref="Baggage"/> with the key/value pair removed.
293293
/// </summary>
294294
/// <param name="name">Baggage item name.</param>
295-
/// <returns>New <see cref="Baggage"/> containing the key/value pair.</returns>
295+
/// <returns>New <see cref="Baggage"/> with the key/value pair removed.</returns>
296296
public Baggage RemoveBaggage(string name)
297297
{
298298
var baggage = new Dictionary<string, string>(this.baggage ?? EmptyBaggage, StringComparer.OrdinalIgnoreCase);
@@ -304,7 +304,7 @@ public Baggage RemoveBaggage(string name)
304304
/// <summary>
305305
/// Returns a new <see cref="Baggage"/> with all the key/value pairs removed.
306306
/// </summary>
307-
/// <returns>New <see cref="Baggage"/> containing the key/value pair.</returns>
307+
/// <returns>New <see cref="Baggage"/> with all the key/value pairs removed.</returns>
308308
public Baggage ClearBaggage()
309309
=> default;
310310

0 commit comments

Comments
 (0)