Add explicit release notes URL when they are mentioned in error messages#6516
Open
0xced wants to merge 1 commit intonpgsql:mainfrom
Open
Add explicit release notes URL when they are mentioned in error messages#65160xced wants to merge 1 commit intonpgsql:mainfrom
0xced wants to merge 1 commit intonpgsql:mainfrom
Conversation
It's not hard to find the Npgsql release notes but it's even better if the exact URL is just one click away because it's included in the error messages.
There was a problem hiding this comment.
Pull request overview
Adds direct links to the relevant Npgsql release notes in user-facing messages (runtime exception text and obsolete API diagnostics), making it easier for users to click through to the exact documentation referenced.
Changes:
- Embed explicit
https://www.npgsql.org/doc/release-notes/<version>.0.htmlURLs in several resource-based error messages (8.0). - Embed explicit release notes URLs in
[Obsolete]messages for deprecated type-mapping configuration APIs (7.0, 9.0). - Regenerate the
NpgsqlStrings.Designer.csresource designer after updating the.resx.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/Npgsql/Properties/NpgsqlStrings.resx | Adds explicit 8.0 release notes URL into multiple user-facing resource strings. |
| src/Npgsql/Properties/NpgsqlStrings.Designer.cs | Updates generated resource accessors/docs to reflect the .resx string changes. |
| src/Npgsql/NpgsqlConnectionStringBuilder.cs | Updates [Obsolete] messages to include the 9.0 release notes URL. |
| src/Npgsql/NpgsqlConnection.cs | Updates [Obsolete] messages/comments to include the 7.0 release notes URL. |
Files not reviewed (1)
- src/Npgsql/Properties/NpgsqlStrings.Designer.cs: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
roji
reviewed
Mar 22, 2026
Member
roji
left a comment
roji
left a comment
There was a problem hiding this comment.
We shouldn't need to point to release notes of a specific version (which BTW will be out of support at the end of the year). If the current docs at /doc/types/basic.html are insufficient, better to improve them rather than pointing people to release notes, IMHO.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
It's not hard to find the Npgsql release notes but it's even better if the exact URL is just one click away because it's included in the error messages.