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

feat!: remove confusing app workers alias #4515

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

TomJGooding
Copy link
Contributor

@TomJGooding TomJGooding commented May 15, 2024

Closes #3619.

I suggest we rename DOMNode.workers to DOMNode.app_workers and/or make it so that DOMNode.workers retrieves all workers started by/associated with the given widget.

There doesn't seem much benefit of just renaming this property if only a shortcut for self.app.workers?

This PR simply removes this confusing alias, but I'm happy to look into workers only tied to the given widget with a bit of guidance.

  • Docstrings on all new or modified functions / classes
  • Updated documentation
  • Updated CHANGELOG.md (where appropriate)

@TomJGooding TomJGooding marked this pull request as ready for review May 15, 2024 23:46
@TomJGooding TomJGooding changed the title feat: remove confusing app workers alias feat!: remove confusing app workers alias May 17, 2024
@darrenburns
Copy link
Member

darrenburns commented Jul 16, 2024

I agree with this change. The alias is definitely confusing. However it'll need @willmcgugan to approve.

(Also needs a breaking change noted in the changelog if approved)

@willmcgugan
Copy link
Collaborator

I think Widget.workers should refer to a pool of workers for the self widget, if that is useful. Otherwise, we can remove the alias altogether.

I do want to do another pass on workers in the near future.

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.

DOMNode.workers is a confusing alias
3 participants