Change returned type references in query builder documentation #2091
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
|
Ah, yes. Those are the kind of ugly APIs that get missed when checking for BC breaks with automated tools. Thanks for fixing the docs, and I agree that we want to add a note to this in the UPGRADE document. Can you please add that to |
sarcher
force-pushed
the
doc-returntype-fix
branch
from
8ee5356
to
5b0c82c
Compare
|
Should be all set; let me know if anything else is needed. Thanks! |
I did it for you. |
greg0ire
approved these changes
Oct 26, 2019
|
Thank you @sarcher! |
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.
Summary
Looks like something that was missed in the 2.x changes;
execute()no longer returns a cursor but anIterator, anddistinct()returns a plain array.I do wonder if there should be an additional note for
distinct()calling out that the returned type is different, since that can be a bit jarring (I was migrating a project and it took me a minute to understand exactly what was different here).