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

The Docs Need to be UPDATE. #2737

Closed
JohnGuan opened this issue Jan 15, 2024 · 1 comment
Closed

The Docs Need to be UPDATE. #2737

JohnGuan opened this issue Jan 15, 2024 · 1 comment

Comments

@JohnGuan
Copy link

What version of this package are you using?
1.9.7 and 2.1.33

What operating system, Node.js, and npm version?
macOS, LTS(18+)

What happened?
After my careful reading of the documentation, code, and testing.
It tortured me for a week. This discrepancy was confirmed by going through the code and history commits after I read the docs thoroughly.
The core problem is. The docs state that downloading a file requires a getBlobURL, and at least 2.1.32. file API has changed drastically.
If following the current docs doesn't work at all for 2.0+ code.

What did you expect to happen?
It seems like we should update the docs.

Are you willing to submit a pull request to fix this bug?
I'd love to! I can try my best. But it would be better if the API author had some basic instructions or a draft.

@ThaUnknown
Copy link
Member

docs on github are up to date
the webtorrent.io website is outdated, but we don't have access to it, as the person that owns it is MIA and isn't updating it

@ThaUnknown ThaUnknown closed this as not planned Won't fix, can't repro, duplicate, stale Feb 17, 2024
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

No branches or pull requests

2 participants