SYSLIB1219 (and placeholder SYSLIB1218) missing from the options-validation source-generator diagnostics reference
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- csharp
- Domain
- documentation
Research direction
Open docs/fundamentals/syslib-diagnostics/syslib1201-1219.md and inspect the existing diagnostics table and front matter. Verify SYSLIB1219 against Microsoft.Extensions.Options/gen/DiagDescriptors.cs, then confirm the intended treatment of reserved SYSLIB1218 with the runtime team. Done means the reference and keywords accurately reflect the supported diagnostics.
Written by the indexing model from the issue text.
Description
Description
The options-validation source-generator diagnostics reference page's front matter (f1_keywords) already lists syslib1218 and syslib1219, but the description table only documents SYSLIB1201-SYSLIB1217. Two diagnostic IDs are undocumented:
SYSLIB1219(AlreadyImplementsValidateAsyncMethod) - a new diagnostic introduced with async options-validation source generation (ValidateAsyncemission forIAsyncValidateOptions<TOptions>), defined inDiagDescriptors.cs. It's the async counterpart to the existingSYSLIB1205(AlreadyImplementsValidateMethod): the generator reports it when an attributed type already provides a handwrittenValidateAsyncmethod matching the generated signature.SYSLIB1218- reserved as a keyword but not currently defined by any diagnostic descriptor in the Options source generator. Needs confirmation of intent (reserved for future use vs. removable from front matter).
Repro / evidence
- Front matter lists both IDs: syslib1201-1219.md front matter
- Table stops at
SYSLIB1217: no rows for 1218/1219. SYSLIB1219diagnostic descriptor:Microsoft.Extensions.Options/gen/DiagDescriptors.cs,id: "SYSLIB1219", messageSR.AlreadyImplementsValidateAsyncMethodMessage.
Suggested content
Add a table row:
| Diagnostic ID | Description |
|---|---|
SYSLIB1219 |
A type already includes an implementation of the ValidateAsync method. |
And either:
- Add a
SYSLIB1218row once its purpose is confirmed with the runtime team, or - Remove
syslib1218fromf1_keywordsif it's unused/reserved and not meant to surface publicly yet.
Type of gap
Not a breaking change - SYSLIB1219 is a new diagnostic tied to a new generator capability (async Validate generation), not a change to previously working behavior. This is a plain content gap in an existing reference page.
Related
- Async options-validation source generation: dotnet/runtime#130263
- Related (already-addressed) breaking-change doc for the async validation contract unification: dotnet/docs#55794 / dotnet/docs#55901 (unrelated to this diagnostic gap)
This issue was drafted with assistance from GitHub Copilot.
- Dominant language
- No language data
- Stars
- 4.8k
- Forks
- 6.1k
- Avg merge
- 12h 19m
- Merged PRs (30d)
- 385
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read 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.
More from dotnet/docs
-
dotnet-fsharp/svc help wanted
Difficulty 1/5 Under an hour Newbie friendliness 90/100
dotnet/docs#56209 · 2 comments ·
Maintainers usually reply within 1 day
-
:watch: Not Triaged
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
:watch: Not Triaged dotnet-fundamentals/svc
Difficulty 1/5 Under an hour Newbie friendliness 82/100
dotnet/docs#54749 · 1 comment ·
Maintainers usually reply within 1 day
-
dotnet-fundamentals/svc waiting-on-feedback
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
dotnet/docs#54363 · 1 comment ·
Maintainers usually reply within 1 day
-
dotnet-csharp/svc lang-reference/subsvc
Difficulty 1/5 1-3 hours Newbie friendliness 70/100
dotnet/docs#54202 · 1 comment ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
letsencrypt/cp-cps#353 ·
-
Link Checker ReportOpenautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
[Docs] - Document minimum Terraform/OpenTofu version (>= 1.11) required by write-only argumentsOpen
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
MagaluCloud/terraform-provider-mgc#323 ·
Maintainers usually reply within 11 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
Maintainers usually reply within 1 day