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

Improve docs of BatchController #196

Merged
merged 1 commit into from
May 27, 2020
Merged

Improve docs of BatchController #196

merged 1 commit into from
May 27, 2020

Conversation

vorner
Copy link
Contributor

@vorner vorner commented Feb 29, 2020

  • Clarify safety of the create method.
  • Link directly to the example on github; this saves some time searching
    for it and it also avoids confusion in which repository the example
    lives, as the trait is re-exported in specs.

Related to amethyst/specs#689.

Please do check that what I state here is correct. It's gathered from reading other documentation and trying to understand it as a user of the library, but I didn't write the code.

I'm not updating the changelog, since there's no actual code change, just some documentation improvements. If you think this still requires an entry, I'll add it.

Also, am I right to assume that if I register a batch that contains some thread-local systems, they'll still be handled as !Send internally and nothing will allow the user to move them to a different thread, etc?

* Clarify safety of the `create` method.
* Link directly to the example on github; this saves some time searching
  for it and it also avoids confusion in which repository the example
  lives, as the trait is re-exported in `specs`.

Related to amethyst/specs#689.
@azriel91
Copy link
Member

bors r+

@bors
Copy link
Contributor

bors bot commented May 27, 2020

Build succeeded:

@bors bors bot merged commit 269e51e into amethyst:master May 27, 2020
@vorner vorner deleted the link-batch-dispatch branch May 28, 2020 06:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants