Documentation missing

Open Beginner friendly

#1,055 opened on Nov 3, 2018 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 1/5
Estimated time: 1-3 hours
Newbie friendliness: 72/100

Issue type: Documentation
Clarity: Clearly specified
Activity status: Stale
Tech stack: csharp
Domain: documentation

Research direction

Open xml/System/String.xml and locate the String.GetHashCode(StringComparison) entry, then compare it with the corresponding source in System.Private.CoreLib/shared/System/String.Comparison.cs. Update the API documentation with guidance on when this overload should be used, and verify the rendered String.GetHashCode reference page contains the new explanation.

Written by the indexing model from the issue text.

Description

area-System.Runtime dotnet-api/prod Pri2 untriaged

The overloaded method public int GetHashCode(StringComparison comparisonType) is not documented. Its is only mentioned it here and there is no guidance when it should be used. The source file says:

> Gets a hash code for this string and this comparison. If strings A and B and comparison C are such that string.Equals(A, B, C), then they will return the same hash code with this comparison C.

See: https://github.com/dotnet/coreclr/blob/master/src/System.Private.CoreLib/shared/System/String.Comparison.cs.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

ID: 46e1d9ef-f477-c47a-da4e-88feb95f6dc9
Version Independent ID: acedf195-f641-b347-39a9-7b3a43d32e00
Content: String.GetHashCode Method (System)
Content Source: xml/System/String.xml
Product: dotnet-api
GitHub Login: @dotnet-bot
Microsoft Alias: dotnetcontent

Dominant language: C#
Stars: 950
Forks: 1.7k
Avg merge: 3d 5h
Merged PRs (30d): 38

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

[quality-improver] Repository Quality: AzureFoundry Extension Missing from Self-Registration Acceptance Test Open

type/automation type/tech-debt

Difficulty 2/5 1-3 hours Newbie friendliness 78/100

microsoft/testfx#11431 · Opened Sep 21, 2026
[Bug]: Composite `ui screenshot` success output ignores `--quiet` Open

bug

Difficulty 2/5 1-3 hours Newbie friendliness 88/100

microsoft/winappCli#914 · Opened Sep 21, 2026
GeometryHelper.FlattenArc / FlattenCubicBezier / FlattenQuadraticBezier emit a NaN point when the segment count truncates to 0 (0/0) — a Path with a sub-pixel arc fail-fasts Windows with D2DERR_BAD_NUMBER (root cause of #8512, #13757) Open

t/bug

Difficulty 2/5 1-3 hours Newbie friendliness 82/100

dotnet/maui#38751 · 1 reaction · Opened Sep 21, 2026
[CI Failure] Flaky: MauiBuildQueueTests.CancelQueuedResource_CompletesGracefullyAndDoesNotAcquireSemaphore asserts exact exception type but sometimes gets TaskCanceledException instead of OperationCanceledException Open

ci-failure-cause test-failure

Difficulty 2/5 1-3 hours Newbie friendliness 82/100

microsoft/aspire#20284 · Opened Sep 21, 2026
The login flow's text-link submit is 42 px tall on a narrow screen; its docblock says 44 Open

area:auth FE mvp P3

Difficulty 2/5 1-3 hours Newbie friendliness 88/100

klasolsson81/jobbliggaren#1788 · Opened Sep 21, 2026

More C# issues