Make FakeTask public on singlethreaded context #10517
Merged
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
alice-i-cecile
added
C-Usability
alice-i-cecile
approved these changes
Nov 15, 2023
|
This was definitely intended to be publicly exported. Merging as trivial. |
rdrpenguin04
pushed a commit
to rdrpenguin04/bevy
that referenced
this pull request
Jan 9, 2024
# Objective - When compiling bevy for both singlethreaded and multithreaded contexts and using `Task` directly, you can run into errors where you expect a `Task` to be returned but `FakeTask` is instead. Due to `FakeTask` being private the only solution is to ignore the return at all however because it *is* returned that isn't totally clear. The error is confusing and doesn't provide a solution or help figuring it out. ## Solution - Made `FakeTask` public and added brief documentation providing a use (none) that helps guide usage (no usage) of FakeTask.
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.
Objective
Taskdirectly, you can run into errors where you expect aTaskto be returned butFakeTaskis instead. Due toFakeTaskbeing private the only solution is to ignore the return at all however because it is returned that isn't totally clear. The error is confusing and doesn't provide a solution or help figuring it out.Solution
FakeTaskpublic and added brief documentation providing a use (none) that helps guide usage (no usage) of FakeTask.