DOCS: Update documentation links (#121)

adamayoung · Sep 5, 2023 · fbb8304 · fbb8304
1 parent c7dcc37
commit fbb8304
Show file tree

Hide file tree

Showing 13 changed files with 104 additions and 104 deletions.
diff --git a/Sources/TMDb/Certifications/CertificationService.swift b/Sources/TMDb/Certifications/CertificationService.swift
@@ -24,9 +24,9 @@ public final class CertificationService {
     ///
     /// Returns an up to date list of the officially supported movie certifications on TMDB.
     ///
-    /// [TMDb API - Movie Certifications](https://developer.themoviedb.org/reference/certification-movie-list)
+    /// [TMDb API - Certifications: Movie Certifications](https://developer.themoviedb.org/reference/certification-movie-list)
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: A dictionary of movie certifications.
     /// 
@@ -44,9 +44,9 @@ public final class CertificationService {
     ///
     /// Returns an up to date list of the officially supported TV certifications on TMDB.
     ///
-    /// [TMDb API - TV show Certifications](https://developer.themoviedb.org/reference/certifications-tv-list)
+    /// [TMDb API - Certifications: TV Certifications](https://developer.themoviedb.org/reference/certifications-tv-list)
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: A dictionary of TV show certifications.
     /// 

diff --git a/Sources/TMDb/Company/CompanyService.swift b/Sources/TMDb/Company/CompanyService.swift
@@ -29,7 +29,7 @@ public final class CompanyService {
     /// - Parameters:
     ///    - id: The identifier of the company.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Matching company.
     ///

diff --git a/Sources/TMDb/Configuration/ConfigurationService.swift b/Sources/TMDb/Configuration/ConfigurationService.swift
@@ -25,9 +25,9 @@ public final class ConfigurationService {
     /// Returns the TMDb API system wide configuration information. The result is cached, so there is no overhead in
     /// making multiple calls.
     ///
-    /// [TMDb API - Configuration: API Configuration](https://developers.themoviedb.org/3/configuration/get-api-configuration)
+    /// [TMDb API - Configuration: Details](https://developer.themoviedb.org/reference/configuration-details)
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: The API configuration.
     /// 
@@ -45,9 +45,9 @@ public final class ConfigurationService {
     ///
     /// Returns the list of countries used throughout TMDb.
     ///
-    /// [TMDb API - Configuration: Countries](https://developers.themoviedb.org/3/configuration/get-countries)
+    /// [TMDb API - Configuration: Countries](https://developer.themoviedb.org/reference/configuration-countries)
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Countries used throughout TMDb,
     /// 
@@ -65,9 +65,9 @@ public final class ConfigurationService {
     ///
     /// Returns a list of the jobs and departments used on TMDb.
     ///
-    /// [TMDb API - Configuration: Jobs](https://developers.themoviedb.org/3/configuration/get-jobs)
+    /// [TMDb API - Configuration: Jobs](https://developer.themoviedb.org/reference/configuration-jobs)
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Jobs and departments used on TMDb.
     /// 
@@ -85,9 +85,9 @@ public final class ConfigurationService {
     ///
     /// Returns the list of languages (ISO 639-1 tags) used throughout TMDb.
     ///
-    /// [TMDb API - Configuration: Languages](https://developers.themoviedb.org/3/configuration/get-languages)
+    /// [TMDb API - Configuration: Languages](https://developer.themoviedb.org/reference/configuration-languages)
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Languages used throughout TMDb.
     ///

diff --git a/Sources/TMDb/Discover/DiscoverService.swift b/Sources/TMDb/Discover/DiscoverService.swift
@@ -24,7 +24,7 @@ public final class DiscoverService {
     ///
     /// Returns movies to be discovered.
     ///
-    /// [TMDb API - Discover: Movies](https://developers.themoviedb.org/3/discover/movie-discover)
+    /// [TMDb API - Discover: Movie](https://developer.themoviedb.org/reference/discover-movie)
     ///
     /// - Precondition: `page` can be between `1` and `1000`.
     ///
@@ -33,7 +33,7 @@ public final class DiscoverService {
     ///    - people: A list of Person identifiers which to return only movies they have appeared in.
     ///    - page: The page of results to return.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Matching movies as a pageable list.
     /// 
@@ -54,15 +54,15 @@ public final class DiscoverService {
     ///
     /// Returns TV shows to be discovered.
     ///
-    /// [TMDb API - Discover: TV Shows](https://developers.themoviedb.org/3/discover/tv-discover)
+    /// [TMDb API - Discover: TV](https://developer.themoviedb.org/reference/discover-tv)
     ///
     /// - Precondition: `page` can be between `1` and `1000`.
     ///
     /// - Parameters:
     ///    - sortedBy: How results should be sorted.
     ///    - page: The page of results to return.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Matching TV shows as a pageable list.
     ///

diff --git a/Sources/TMDb/Genres/GenreService.swift b/Sources/TMDb/Genres/GenreService.swift
@@ -24,9 +24,9 @@ public final class GenreService {
     ///
     /// Returns the list of official genres for movies.
     ///
-    /// [TMDb API - Genres: Movies](https://developers.themoviedb.org/3/genres/get-movie-list)
+    /// [TMDb API - Genres: Movie List](https://developer.themoviedb.org/reference/genre-movie-list)
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: A list of genres.
     ///
@@ -44,9 +44,9 @@ public final class GenreService {
     ///
     /// Returns the list of official genres for TV shows.
     ///
-    /// [TMDb API - Genres: Movies](https://developers.themoviedb.org/3/genres/get-tv-list)
+    /// [TMDb API - Genres: TV List](https://developer.themoviedb.org/reference/genre-tv-list)
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: A list of genres.
     /// 

diff --git a/Sources/TMDb/Movies/MovieService.swift b/Sources/TMDb/Movies/MovieService.swift
@@ -27,12 +27,12 @@ public final class MovieService {
     ///
     /// Returns the primary information about a movie.
     ///
-    /// [TMDb API - Movie: Details](https://developers.themoviedb.org/3/movies/get-movie-details)
+    /// [TMDb API - Movies: Details](https://developer.themoviedb.org/reference/movie-details)
     ///
     /// - Parameters:
     ///    - id: The identifier of the movie.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: The matching movie.
     /// 
@@ -50,12 +50,12 @@ public final class MovieService {
     ///
     /// Returns the cast and crew of a movie.
     ///
-    /// [TMDb API - Movie: Credits](https://developers.themoviedb.org/3/movies/get-movie-credits)
+    /// [TMDb API - Movies: Credits](https://developer.themoviedb.org/reference/movie-credits)
     ///
     /// - Parameters:
     ///    - movieID: The identifier of the movie.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Credits for the matching movie.
     /// 
@@ -73,15 +73,15 @@ public final class MovieService {
     ///
     /// Returns the user reviews for a movie.
     ///
-    /// [TMDb API - Movie: Reviews](https://developers.themoviedb.org/3/movies/get-movie-reviews)
+    /// [TMDb API - Movies: Reviews](https://developer.themoviedb.org/reference/movie-reviews)
     ///
     /// - Precondition: `page` can be between `1` and `1000`.
     ///
     /// - Parameters:
     ///    - movieID: The identifier of the movie.
     ///    - page: The page of results to return.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Reviews for the matching movie as a pageable list.
     /// 
@@ -99,12 +99,12 @@ public final class MovieService {
     ///
     /// Returns the images that belong to a movie.
     ///
-    /// [TMDb API - Movie: Images](https://developers.themoviedb.org/3/movies/get-movie-images)
+    /// [TMDb API - Movies: Images](https://developer.themoviedb.org/reference/movie-images)
     ///
     /// - Parameters:
     ///    - movieID: The identifier of the movie.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Collection of images for the matching movie.
     /// 
@@ -125,12 +125,12 @@ public final class MovieService {
     ///
     /// Returns the videos that have been added to a movie.
     ///
-    /// [TMDb API - Movie: Videos](https://developers.themoviedb.org/3/movies/get-movie-videos)
+    /// [TMDb API - Movies: Videos](https://developer.themoviedb.org/reference/movie-videos)
     ///
     /// - Parameters:
     ///    - movieID: The identifier of the movie.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Collection of videos for the matching movie.
     ///
@@ -151,15 +151,15 @@ public final class MovieService {
     ///
     /// Returns a list of recommended movies for a movie.
     ///
-    /// [TMDb API - Movie: Recommendations](https://developers.themoviedb.org/3/movies/get-movie-recommendations)
+    /// [TMDb API - Movies: Recommendations](https://developer.themoviedb.org/reference/movie-recommendations)
     ///
     /// - Precondition: `page` can be between `1` and `1000`.
     ///
     /// - Parameters:
     ///    - movieID: The identifier of the movie for get recommendations for.
     ///    - page: The page of results to return.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Recommended movies for the matching movie as a pageable list.
     /// 
@@ -179,15 +179,15 @@ public final class MovieService {
     ///
     /// This is not the same as the *Recommendations*.
     ///
-    /// [TMDb API - Movie: Similar](https://developers.themoviedb.org/3/movies/get-similar-movies)
+    /// [TMDb API - Movies: Similar](https://developer.themoviedb.org/reference/movie-similar)
     ///
     /// - Precondition: `page` can be between `1` and `1000`.
     ///
     /// - Parameters:
     ///    - movieID: The identifier of the movie for get similar movies for.
     ///    - page: The page of results to return.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Similar movies for the matching movie as a pageable list.
     /// 
@@ -205,14 +205,14 @@ public final class MovieService {
     ///
     /// Returns a list of currently playing movies.
     ///
-    /// [TMDb API - Movie: Now Playing](https://developers.themoviedb.org/3/movies/get-now-playing)
+    /// [TMDb API - Movie Lists: Now Playing](https://developer.themoviedb.org/reference/movie-now-playing-list)
     ///
     /// - precondition: `page` can be between `1` and `1000`.
     ///
     /// - Parameters:
     ///    - page: The page of results to return.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Now playing movies as a pageable list.
     /// 
@@ -230,14 +230,14 @@ public final class MovieService {
     ///
     /// Returns a list of current popular movies.
     ///
-    /// [TMDb API - Movie: Popular](https://developers.themoviedb.org/3/movies/get-popular-movies)
+    /// [TMDb API - Movie List: Popular](https://developer.themoviedb.org/reference/movie-popular-list)
     ///
     /// - precondition: `page` can be between `1` and `1000`.
     ///
     /// - Parameters:
     ///    - page: The page of results to return.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Current popular movies as a pageable list.
     /// 
@@ -255,14 +255,14 @@ public final class MovieService {
     ///
     /// Returns a list of top rated movies.
     ///
-    /// [TMDb API - Movie: Top Rated](https://developers.themoviedb.org/3/movies/get-top-rated-movies)
+    /// [TMDb API - Movie List: Top Rated](https://developer.themoviedb.org/reference/movie-top-rated-list)
     ///
     /// - precondition: `page` can be between `1` and `1000`.
     ///
     /// - Parameters:
     ///    - page: The page of results to return.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Top rated movies as a pageable list.
     /// 
@@ -280,14 +280,14 @@ public final class MovieService {
     ///
     /// Returns a list of upcoming movies.
     ///
-    /// [TMDb API - Movie: Upcoming](https://developers.themoviedb.org/3/movies/get-upcoming)
+    /// [TMDb API - Movie List: Upcoming](https://developer.themoviedb.org/reference/movie-upcoming-list)
     ///
     /// - precondition: `page` can be between `1` and `1000`.
     ///
     /// - Parameters:
     ///    - page: The page of results to return.
     ///
-    /// - Throws: TMDb data error ``TMDbError``.
+    /// - Throws: TMDb error ``TMDbError``.
     ///
     /// - Returns: Upcoming movies as a pageable list.
     ///