Skip to content
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.

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 by Bors] - fix failing doc test and clear up docs for TaskPool::scope #6314

Closed
wants to merge 2 commits into from

Conversation

hymm
Copy link
Contributor

@hymm hymm commented Oct 20, 2022

Objective

Fixes #6306

Solution

Change the failing assert and expand example to explain when ordering is deterministic or not.

# Objective

Alternative to bevyengine#6150

Dependabot's PR doesn't seem to break anything, but there are some deprecations that we might as well fix up.

## Solution

https://github.com/clap-rs/clap/blob/master/CHANGELOG.md#migrating

Update clap in `build-wasm-example` and `span-cmp`. Other tools don't use clap.

Remove references to `value_parser`. It's the default now.

Change `#[clap()]` to `#[arg()]`.

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@alice-i-cecile alice-i-cecile added C-Bug An unexpected or incorrect behavior A-Build-System Related to build systems or continuous integration C-Testing A change that impacts how we test Bevy or how users test their apps A-Tasks Tools for parallel and async work labels Oct 20, 2022
@mockersf
Copy link
Member

mockersf commented Oct 20, 2022

I would prefer to avoid leaving commented code in doc, because it will probably not be updated when the API change. Is it possible to explain the non deterministicness without it? or change the assert so that it doesn't care about the order.

@mockersf mockersf added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Oct 20, 2022
@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Oct 20, 2022
# Objective

Fixes #6306

## Solution
 Change the failing assert and expand example to explain when ordering is deterministic or not.

Co-authored-by: Mike Hsu <mike.hsu@gmail.com>
@bors
Copy link
Contributor

bors bot commented Oct 20, 2022

@bors bors bot changed the title fix failing doc test and clear up docs [Merged by Bors] - fix failing doc test and clear up docs Oct 20, 2022
@bors bors bot closed this Oct 20, 2022
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
# Objective

Fixes bevyengine#6306

## Solution
 Change the failing assert and expand example to explain when ordering is deterministic or not.

Co-authored-by: Mike Hsu <mike.hsu@gmail.com>
@hymm hymm changed the title [Merged by Bors] - fix failing doc test and clear up docs [Merged by Bors] - fix failing doc test and clear up docs for TaskPool::scope Nov 10, 2022
Pietrek14 pushed a commit to Pietrek14/bevy that referenced this pull request Dec 17, 2022
# Objective

Fixes bevyengine#6306

## Solution
 Change the failing assert and expand example to explain when ordering is deterministic or not.

Co-authored-by: Mike Hsu <mike.hsu@gmail.com>
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# Objective

Fixes bevyengine#6306

## Solution
 Change the failing assert and expand example to explain when ordering is deterministic or not.

Co-authored-by: Mike Hsu <mike.hsu@gmail.com>
@hymm hymm deleted the task-pool-flaky-test branch October 2, 2023 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build-System Related to build systems or continuous integration A-Tasks Tools for parallel and async work C-Bug An unexpected or incorrect behavior C-Testing A change that impacts how we test Bevy or how users test their apps S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Flaky doc test in bevy_tasks
4 participants