Documentation error on "stream-controller.ts" in "design.md" under "docs" folder

[neil-liu]

What version of Hls.js are you using?

v1.5.8

What browser (including version) are you using?

Chrome 123.0.6312.106

What OS (including version) are you using?

Windows 10

Test stream

Any test stream on the demo web site can be used to verify if needed. https://hlsjs.video-dev.org/demo/

Configuration

{}

Additional player setup steps

None

Checklist

• The issue observed is not already reported by searching on Github under https://github.com/video-dev/hls.js/issues
• The issue occurs in the stable client (latest release) on https://hlsjs.video-dev.org/demo and not just on my page
• The issue occurs in the latest client (main branch) on https://hlsjs-dev.video-dev.org/demo and not just on my page
• The stream has correct Access-Control-Allow-Origin headers (CORS)
• There are no network errors such as 404s in the browser console when trying to play the stream

Steps to reproduce

1. Open link: https://github.com/video-dev/hls.js/blob/master/docs/design.md
2. Scroll to the line that contains text 'src/controller/stream-controller.ts'
3. Under above line, the first bullet point says 'stream controller is in charge of:'. The next line says:
   "triggering BUFFER_RESET on MANIFEST_PARSED or startLoad()"

Expected behaviour

The line that that says "triggering BUFFER_RESET on MANIFEST_PARSED or startLoad()" is not correct because BUFFER_RESET is (and only is) triggered on MANIFEST_LOADING. This can be confirmed in "onManifestLoading()" of "stream-controller.ts". Therefore, the line should say "triggering BUFFER_RESET on MANIFEST_LOADING" instead.

What actually happened?

Incorrect description was displayed:
"triggering BUFFER_RESET on MANIFEST_PARSED or startLoad()"

Console output

N/A. The issue is just an error with the documentation about 'src/controller/stream-controller.ts'.

Chrome media internals output

N/A