fix doctests

deepgram · Aug 9, 2024 · a9035fc · a9035fc
1 parent bdeb141
commit a9035fc
Show file tree

Hide file tree

Showing 11 changed files with 31 additions and 31 deletions.
diff --git a/src/common/options.rs b/src/common/options.rs
@@ -1023,10 +1023,10 @@ impl OptionsBuilder {
     /// #
     /// # static AUDIO_URL: &str = "https://static.deepgram.com/examples/Bueller-Life-moves-pretty-fast.wav";
     /// #
-    /// # fn main() -> Result<(), reqwest::Error> {
+    /// # fn main() -> Result<(), deepgram::DeepgramError> {
     /// # let deepgram_api_key = env::var("DEEPGRAM_API_KEY").unwrap_or_default();
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     /// let dg_transcription = dg_client.transcription();
     ///
     /// let options1 = Options::builder()

diff --git a/src/lib.rs b/src/lib.rs
@@ -301,7 +301,7 @@ impl Deepgram {
             client: reqwest::Client::builder()
                 .user_agent(USER_AGENT)
                 .default_headers(authorization_header)
-                .build()?
+                .build()?,
         })
     }
 }

diff --git a/src/listen/rest.rs b/src/listen/rest.rs
@@ -43,7 +43,7 @@ impl Transcription<'_> {
     /// # let deepgram_api_key =
     /// #     env::var("DEEPGRAM_API_KEY").expect("DEEPGRAM_API_KEY environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let source = AudioSource::from_url(AUDIO_URL);
     ///
@@ -97,7 +97,7 @@ impl Transcription<'_> {
     /// # let deepgram_api_key =
     /// #     env::var("DEEPGRAM_API_KEY").expect("DEEPGRAM_API_KEY environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let source = AudioSource::from_url(AUDIO_URL);
     ///
@@ -153,12 +153,12 @@ impl Transcription<'_> {
     /// # static AUDIO_URL: &str = "https://static.deepgram.com/examples/Bueller-Life-moves-pretty-fast.wav";
     /// #
     /// # #[tokio::main]
-    /// # async fn main() -> reqwest::Result<()> {
+    /// # async fn main() -> Result<(), DeepgramError> {
     /// #
     /// # let deepgram_api_key =
     /// #     env::var("DEEPGRAM_API_KEY").expect("DEEPGRAM_API_KEY environmental variable");
     /// #
-    /// # let dg_client = Deepgram::new(&deepgram_api_key);
+    /// # let dg_client = Deepgram::new(&deepgram_api_key)?;
     /// #
     /// # let source = AudioSource::from_url(AUDIO_URL);
     /// #
@@ -221,12 +221,12 @@ impl Transcription<'_> {
     /// # static AUDIO_URL: &str = "https://static.deepgram.com/examples/Bueller-Life-moves-pretty-fast.wav";
     /// #
     /// # #[tokio::main]
-    /// # async fn main() -> reqwest::Result<()> {
+    /// # async fn main() -> Result<(), DeepgramError> {
     /// #
     /// # let deepgram_api_key =
     /// #     env::var("DEEPGRAM_API_KEY").expect("DEEPGRAM_API_KEY environmental variable");
     /// #
-    /// # let dg_client = Deepgram::new(&deepgram_api_key);
+    /// # let dg_client = Deepgram::new(&deepgram_api_key)?;
     /// #
     /// # let source = AudioSource::from_url(AUDIO_URL);
     /// #

diff --git a/src/listen/websocket.rs b/src/listen/websocket.rs
@@ -85,7 +85,7 @@ impl Transcription<'_> {
     ///     listen::websocket::WebsocketBuilder,
     /// };
     ///
-    /// let dg = Deepgram::new(std::env::var("DEEPGRAM_API_TOKEN").unwrap_or_default());
+    /// let dg = Deepgram::new(std::env::var("DEEPGRAM_API_TOKEN").unwrap_or_default()).unwrap();
     /// let transcription = dg.transcription();
     /// let builder: WebsocketBuilder<'_> = transcription
     ///     .stream_request()
@@ -114,7 +114,7 @@ impl Transcription<'_> {
     ///     },
     /// };
     ///
-    /// let dg = Deepgram::new(std::env::var("DEEPGRAM_API_TOKEN").unwrap_or_default());
+    /// let dg = Deepgram::new(std::env::var("DEEPGRAM_API_TOKEN").unwrap_or_default()).unwrap();
     /// let transcription = dg.transcription();
     /// let options = Options::builder()
     ///     .model(Model::Nova2)
@@ -180,7 +180,7 @@ impl<'a> WebsocketBuilder<'a> {
     ///     },
     /// };
     ///
-    /// let dg = Deepgram::new(std::env::var("DEEPGRAM_API_TOKEN").unwrap_or_default());
+    /// let dg = Deepgram::new(std::env::var("DEEPGRAM_API_TOKEN").unwrap_or_default()).unwrap();
     /// let transcription = dg.transcription();
     /// let options = Options::builder()
     ///     .model(Model::Nova2)

diff --git a/src/manage/billing.rs b/src/manage/billing.rs
@@ -56,7 +56,7 @@ impl Billing<'_> {
     /// # let project_id =
     /// #     env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let balances = dg_client
     ///     .billing()
@@ -98,7 +98,7 @@ impl Billing<'_> {
     /// # let balance_id =
     /// #     env::var("DEEPGRAM_BALANCE_ID").expect("DEEPGRAM_BALANCE_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let balance = dg_client
     ///     .billing()

diff --git a/src/manage/invitations.rs b/src/manage/invitations.rs
@@ -56,7 +56,7 @@ impl Invitations<'_> {
     /// # let project_id =
     /// #     env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// dg_client
     ///     .invitations()

diff --git a/src/manage/keys.rs b/src/manage/keys.rs
@@ -63,7 +63,7 @@ impl Keys<'_> {
     /// # let project_id =
     /// #     env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let keys = dg_client
     ///     .keys()
@@ -102,7 +102,7 @@ impl Keys<'_> {
     /// #
     /// # let key_id = env::var("DEEPGRAM_KEY_ID").expect("DEEPGRAM_KEY_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let key = dg_client
     ///     .keys()
@@ -144,7 +144,7 @@ impl Keys<'_> {
     /// #
     /// # let key_id = env::var("DEEPGRAM_KEY_ID").expect("DEEPGRAM_KEY_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let options = Options::builder("New Key", ["member"]).build();
     /// let new_key = dg_client
@@ -189,7 +189,7 @@ impl Keys<'_> {
     /// #
     /// # let key_id = env::var("DEEPGRAM_KEY_ID").expect("DEEPGRAM_KEY_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// dg_client
     ///     .keys()

diff --git a/src/manage/members.rs b/src/manage/members.rs
@@ -56,7 +56,7 @@ impl Members<'_> {
     /// # let project_id =
     /// #     env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let members = dg_client
     ///     .members()
@@ -99,7 +99,7 @@ impl Members<'_> {
     /// # let member_id =
     /// #     env::var("DEEPGRAM_MEMBER_ID").expect("DEEPGRAM_MEMBER_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// dg_client
     ///     .members()

diff --git a/src/manage/projects.rs b/src/manage/projects.rs
@@ -59,7 +59,7 @@ impl Projects<'_> {
     /// # let deepgram_api_key =
     /// #     env::var("DEEPGRAM_API_KEY").expect("DEEPGRAM_API_KEY environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let projects = dg_client
     ///     .projects()
@@ -96,7 +96,7 @@ impl Projects<'_> {
     /// # let project_id =
     /// #     env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let project = dg_client
     ///     .projects()
@@ -133,7 +133,7 @@ impl Projects<'_> {
     /// # let project_id =
     /// #     env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let options = Options::builder()
     ///     .name("The Transcribinator")
@@ -180,7 +180,7 @@ impl Projects<'_> {
     /// # let project_id =
     /// #     env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// dg_client
     ///     .projects()

diff --git a/src/manage/scopes.rs b/src/manage/scopes.rs
@@ -61,7 +61,7 @@ impl Scopes<'_> {
     /// # let member_id =
     /// #     env::var("DEEPGRAM_MEMBER_ID").expect("DEEPGRAM_MEMBER_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let scopes = dg_client
     ///     .scopes()
@@ -108,7 +108,7 @@ impl Scopes<'_> {
     /// # let member_id =
     /// #     env::var("DEEPGRAM_MEMBER_ID").expect("DEEPGRAM_MEMBER_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// dg_client
     ///     .scopes()

diff --git a/src/manage/usage.rs b/src/manage/usage.rs
@@ -62,7 +62,7 @@ impl Usage<'_> {
     /// # let project_id =
     /// #     env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let options = list_requests_options::Options::builder().build();
     /// let requests = dg_client
@@ -118,7 +118,7 @@ impl Usage<'_> {
     /// # let request_id =
     /// #     env::var("DEEPGRAM_REQUEST_ID").expect("DEEPGRAM_REQUEST_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let request = dg_client
     ///     .usage()
@@ -161,7 +161,7 @@ impl Usage<'_> {
     /// # let project_id =
     /// #     env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let options = get_usage_options::Options::builder().build();
     /// let summary = dg_client
@@ -211,7 +211,7 @@ impl Usage<'_> {
     /// # let project_id =
     /// #     env::var("DEEPGRAM_PROJECT_ID").expect("DEEPGRAM_PROJECT_ID environmental variable");
     /// #
-    /// let dg_client = Deepgram::new(&deepgram_api_key);
+    /// let dg_client = Deepgram::new(&deepgram_api_key)?;
     ///
     /// let options = get_fields_options::Options::builder().build();
     /// let summary = dg_client