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

Add additional documentation for workerPath config #5765

Merged
merged 1 commit into from
Aug 28, 2023

Conversation

mogzol
Copy link
Contributor

@mogzol mogzol commented Aug 23, 2023

This PR will...

Add additional documentation around the workerPath config and the ESM distribution.

  • Adds a section to MIRATING.md mentioning that workerPath should be included when using the ESM distribution and wanting web workers to be enabled.
  • Adds a comment to the code example in API.md about the above
  • Adds a note in the workerPath documentation in API.md about the above

Why is this Pull Request needed?

See the comments on #5757

Are there any points in the code the reviewer needs to double check?

No, this is just a small documentation change

Resolves issues:

None. Related to #5757, but does not resolve the actual issue.

Checklist

  • changes have been done against master branch, and PR does not conflict
  • new unit / functional tests have been added (whenever applicable)
  • API or design changes are documented in API.md

@robwalch robwalch added this to the 1.5.0 milestone Aug 23, 2023
@robwalch robwalch merged commit edcef9a into video-dev:master Aug 28, 2023
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.

2 participants