Skip to content

add release notes for query iter sorts#1460

Merged
alice-i-cecile merged 5 commits intobevyengine:mainfrom
Victoronz:query-sort-release-notes
Jun 27, 2024
Merged

add release notes for query iter sorts#1460
alice-i-cecile merged 5 commits intobevyengine:mainfrom
Victoronz:query-sort-release-notes

Conversation

@Victoronz
Copy link
Copy Markdown
Contributor

@Victoronz Victoronz commented Jun 26, 2024

Closes #1322

This is an initial draft, I still want to have a read through the existing release notes, and match the language/tone if necessary.
I'll also see if there's anything I would like to expand upon/change/cut before requesting review.

@Victoronz
Copy link
Copy Markdown
Contributor Author

Victoronz commented Jun 26, 2024

So while writing this, I have just discovered something interesting: The PR implementing the full set of sort methods didn't actually implement the full set of sort methods... sort_unstable_by_key is missing...
I'll make a PR for that immediately, is simply a missing variation of what is already there.

@Victoronz
Copy link
Copy Markdown
Contributor Author

otherwise, this should be ready for first review!

@Victoronz Victoronz marked this pull request as ready for review June 26, 2024 22:18
@alice-i-cecile
Copy link
Copy Markdown
Member

Said missing feature: bevyengine/bevy#14040

Keep in mind that the lensing does add some overhead, so these query iterator sorts do not perform equally to a manual sort on average. However, this *strongly* depends on workload, so best test it yourself if relevant!
The sorts themselves are not yet cached between system runs, and these methods only sort iterators, not underlying query storage.

Note that query iteration might happen in a deterministic order for now, but that may change anytime over future releases.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be cut.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cut the last 2 sentences. Some people care a lot about sort performance, so I think the mention of it should remain.
It is not some simple "sort sugar" like itertools, but that might not be clear.

Copy link
Copy Markdown
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good writing and nice examples, but too long :) I've left some suggestions on what can be cut down.

Copy link
Copy Markdown
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic; thanks for being so prompt and receptive to the editing :)

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jun 26, 2024
@Victoronz
Copy link
Copy Markdown
Contributor Author

No worries, I am not too familiar with the bevy release note style, and did put this together rather quickly after all ^^

Merged via the queue into bevyengine:main with commit 6dce129 Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write release notes for PR #13417: implement the full set of sort methods on QueryIter

2 participants