Skip to content
This repository has been archived by the owner on Nov 5, 2023. It is now read-only.

Commit

Permalink
Add in docs for the new unranked variants
Browse files Browse the repository at this point in the history
  • Loading branch information
CosmicHorrorDev committed May 12, 2020
1 parent e93789c commit 2fcee68
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/Authenticated-Endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ All functionality with the authenticated API is exposed from `subwinder` through
* [`.download_subtitles()`](#download_subtitlesdownloads-download_dir-name_format)
* [`.get_comments()`](#get_commentssub_containers)
* [`.guess_media()`](#guess_mediaqueries-ranking_func-rank_args-rank_kwargs)
* [`.guess_media_unranked()`](#guess_media_unranked_queries)
* [`.preview_subtitles`](#preview_subtitlessub_containers)
* [`.ping()`](#ping)
* [`.report_movie()`](#report_moviesub_container)
* [`.search_subtitles()`](#search_subtitlesqueries-ranking_func-rank_args-rank_kwargs)
* [`.search_subtitles_unranked()`](#search_subtitles_unrankedqueries)
* [`.suggest_media()`](#suggest_mediaquery)
* [`.user_info()`](#user_info)
* [`.vote()`](#votesub_container-score)
Expand Down Expand Up @@ -163,6 +165,15 @@ guesses = asw.get_comments(
)
```

### `.guess_media_unranked(queries)`

Same as `.guess_media(...)`, but returns the full [`GuessMediaResult`](Custom-Classes.md#guessmediaresult) from before the ranking function is used.

| Param | Type | Description |
| :---: | :---: | :--- |
| `queries` | `List[str]` | The list of strings to guess media for |

**Returns:** a list of `GuessMediaResult` objects for each query in `queries`.
### `.preview_subtitles(sub_containers)`

Gets a preview for the given list of subtitles. This can be used to try and determine the quality of subtitles before downloading them.
Expand Down Expand Up @@ -232,6 +243,16 @@ search_results = asw.search_subtitles(
)
```

### `.search_subtitles_unranked(queries)`

Same as `.search_subtitles(...)`, but returns the full list of `SearchResults` for each query without ranking them to find the "best" one.

| Param | Type | Description |
| :---: | :---: | :--- |
| `queries` | [`List[Media or MovieInfo or EpisodeInfo]`](Custom-Classes.md) | The list of objects the you would like to search subtitles for |

**Returns:** a list of `None` or lists of [`SearchResult`](Custom-Classes.md#searchresult) representing the full list of search result for each query in `queries`.

### `.suggest_media(query)`

Much like `guess_media` this attempts to guess the media for `query`. I'm honestly not sure how much it's use-case differs from that of `guess_media` other than only taking one query.
Expand Down

0 comments on commit 2fcee68

Please sign in to comment.