Skip to content

docs: stop counting diagnostics in the root README #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Katyara11 merged 1 commit into from
Nov 7, 2026
Merged

docs: stop counting diagnostics in the root README #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,11 @@ public interface IRepositoryClient
```

A source generator emits the implementation at compile time — no reflection, no proxy types,
trimming- and AOT-safe. Mistakes are build errors rather than 3am production errors: eighteen
diagnostics cover a `{placeholder}` with no matching parameter, two `[Body]` parameters, an
unbindable parameter, a synchronous return type, a non-absolute `[BaseAddress]`, and more — each
with a location and a sentence saying what to do.
trimming- and AOT-safe. Mistakes are build errors rather than 3am production errors: a
`{placeholder}` with no matching parameter, two `[Body]` parameters, an unbindable parameter, a
synchronous return type, a non-absolute `[BaseAddress]`, a query type that cannot be sent, a
response type missing from your JSON context — each with a location and a sentence saying what to
do. The full set is in [docs/diagnostics.md](docs/diagnostics.md).

A parameter with no attribute binds to a path placeholder of the same name. Anything else is an
error, because guessing that an unbound parameter "must be a query parameter" is how a secret ends
Expand Down
Loading