docs(changelog): be more verbose about offline mode breaking change #2603
Conversation
This file contains 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
abonander
requested changes
Jul 9, 2023
CHANGELOG.md
Outdated
| @@ -21,7 +21,7 @@ alongside drivers for other proprietary databases, with the goal to support full | |||
|
|
|||
| If interested, please email your inquiry to sqlx@launchbadge.com. | |||
|
|
|||
| The offline mode for the queries has been changed to use a separate file per `query!()` invocation, | |||
| The offline mode for the queries (CLI flag `--merged`) has been changed to use a separate file per `query!()` invocation, | |||
There was a problem hiding this comment.
Looking at the discussion, this doesn't seem like it would have been enough information to resolve the confusion. Adding the steps from the last reply in that thread would be much clearer.
There was a problem hiding this comment.
I understand. I'll try to rephrase it in relatively compact fashion. However I'd still explicitly mention --merged.
As a sqlx user, when I noticed that it doesn't work with 0.7.0 my first go to was CHANGELOG and CTRL + F. Searching for "offline" wasn't that obvious at first.
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.
related discussion #1163 (comment)