-
Notifications
You must be signed in to change notification settings - Fork 54
Add principles for task sources #590
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds new documentation guidance for spec authors on task source usage, emphasizing the preference for existing task sources over creating new ones. This guidance aims to improve interoperability, predictability, and performance scheduling across the web platform.
- Added a new section recommending the use of existing generic task sources
- Provided clear criteria for when creating new task sources is justified
- Encouraged use of HTML's wrapper algorithms for task queuing
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Apologies for the drive-by comment, and this comment applies as much to a number of other principles which have been added in the last few years as it does to this, but: We wrote a style guide for TAG design principles which includes this guidance:
(emphasis added) As an example, I think this guidance should begin with (some version of) the sentence "Use the generic or preexisting task sources whenever possible", rather than with an explanation of background with no indication of where in the text the actual guidance will be given. |
Co-authored-by: Martin Thomson <mt@lowentropy.net>
Co-authored-by: Martin Thomson <mt@lowentropy.net>
closes #38
This pull request adds new documentation guidance to the
index.bs
file, advising spec authors to prefer existing task sources rather than creating new ones, unless there is a clear, spec-driven reason. This helps improve interoperability, predictability, and performance scheduling across the platform.Guidance on task source usage:
queue a global task
,queue an element task
) and advised against specifying a particular event loop unless necessary.Preview | Diff