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

Fix ratio limit in documentation #1338

Merged
merged 1 commit into from Mar 25, 2018
Merged
Changes from all commits
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

Fix ratio limit in documentation

The value of ratio isn't limited to 0-1, which can be checked in the two first links below. It probably was a mistake caused by copy-pasting the documentation of "progress", which is limited to 0-1. The commit where this extra info was added is the one in the third link.

- https://github.com/webtorrent/webtorrent/blob/b53d224cdea46173ea97dc9eea7eaf5a6e7a55b9/lib/torrent.js#L177-L179
- https://github.com/webtorrent/webtorrent/blob/b53d224cdea46173ea97dc9eea7eaf5a6e7a55b9/index.js#L195-L205
- 6f2e85c

As this value is the result of something like `uploaded / max(1, downloaded)` it never get's to `Infinity`, so it's limited by 0 and `uploaded`. Without the ` || 1` part it would be limited between 0 and infinity.
  • Loading branch information
qgustavor committed Mar 23, 2018
commit 69a89da6414d7566c494e781bc8d7e5036ea84be
@@ -196,7 +196,7 @@ Total download progress for all **active** torrents, from 0 to 1.

## `client.ratio`

Aggregate "seed ratio" for all torrents (uploaded / downloaded), from 0 to 1.
Aggregate "seed ratio" for all torrents (uploaded / downloaded).


# Torrent API
@@ -252,7 +252,7 @@ Torrent download progress, from 0 to 1.

## `torrent.ratio`

Torrent "seed ratio" (uploaded / downloaded), from 0 to 1.
Torrent "seed ratio" (uploaded / downloaded).

## `torrent.numPeers`

ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.