Improve documentation of StringValues.IsNullOrEmpty() with regard to empty string

[scharnyw]

Description

The docs on StringValues.IsNullOrEmpty() says that the method returns:

runtime/src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs

Line 422 in 5ef6a06

/// <returns>true if <paramref name="value">value</paramref> contains a single null string or empty array; otherwise, false.</returns>

This is not technically correct, since the method also returns true if the StringValues contains a single empty string:

var value = (StringValues)"";
var empty = StringValues.IsNullOrEmpty(value); // true

value = (StringValues)new[] { "" };
empty = StringValues.IsNullOrEmpty(value); // true

For the sake of correctness I suggest changing the docs to:

returns true if value contains a single null or empty string or an empty array; otherwise, false.

Configuration

Regression?

Other information

[dotnet-issue-labeler]

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

[ghost]

Tagging subscribers to this area: @eerhardt, @maryamariyan
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Description

The docs on StringValues.IsNullOrEmpty() says that the method returns:

runtime/src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs

Line 422 in 5ef6a06

/// <returns>true if <paramref name="value">value</paramref> contains a single null string or empty array; otherwise, false.</returns>

This is not technically correct, since the method also returns true if the StringValues contains a single empty string:

var value = (StringValues)"";
var empty = StringValues.IsNullOrEmpty(value); // true

value = (StringValues)new[] { "" };
empty = StringValues.IsNullOrEmpty(value); // true

For the sake of correctness I suggest changing the docs to:

returns true if value contains a single null or empty string or an empty array; otherwise, false.

Configuration

Regression?

Other information

Author:	scharnyw
Assignees:	-
Labels:	area-Extensions-Primitives, in pr, untriaged
Milestone:	-