Skip to content

Commit

Permalink
Fix ratio limit in documentation
Browse files Browse the repository at this point in the history
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
1 parent b53d224 commit 69a89da
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/api.md
Expand Up @@ -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
Expand Down Expand Up @@ -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`

Expand Down

0 comments on commit 69a89da

Please sign in to comment.