Skip to content

Commit 5205efb

Browse files
authored
simplify doctests that don't run using panic!()
1 parent 904c66c commit 5205efb

File tree

4 files changed

+18
-43
lines changed

4 files changed

+18
-43
lines changed

sdk/cosmos/azure_data_cosmos/src/clients/container_client.rs

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,8 @@ pub trait ContainerClientMethods {
3232
///
3333
/// ```rust,no_run
3434
/// # async fn doc() {
35-
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
36-
/// # let credential = azure_identity::create_default_credential().unwrap();
37-
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
38-
/// # let db_client = client.database_client("my_database");
39-
/// # let container_client = db_client.container_client("my_container");
35+
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
36+
/// # let container_client: ContainerClient = todo!("this is a non-running example");
4037
/// let response = container_client.read(None)
4138
/// .await.unwrap()
4239
/// .deserialize_body()
@@ -71,11 +68,8 @@ pub trait ContainerClientMethods {
7168
///
7269
/// ```rust,no_run
7370
/// # async fn doc() {
74-
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
75-
/// # let credential = azure_identity::create_default_credential().unwrap();
76-
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
77-
/// # let db_client = client.database_client("my_database");
78-
/// # let container_client = db_client.container_client("my_container");
71+
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
72+
/// # let container_client: ContainerClient = todo!("this is a non-running example");
7973
/// #[derive(serde::Deserialize)]
8074
/// struct Customer {
8175
/// id: u64,
@@ -92,11 +86,8 @@ pub trait ContainerClientMethods {
9286
///
9387
/// ```rust,no_run
9488
/// # async fn doc() {
95-
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods, Query};
96-
/// # let credential = azure_identity::create_default_credential().unwrap();
97-
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
98-
/// # let db_client = client.database_client("my_database");
99-
/// # let container_client = db_client.container_client("my_container");
89+
/// # use azure_data_cosmos::{Query, clients::{ContainerClient, ContainerClientMethods}};
90+
/// # let container_client: ContainerClient = todo!("this is a non-running example");
10091
/// #[derive(serde::Deserialize)]
10192
/// struct Customer {
10293
/// id: u64,

sdk/cosmos/azure_data_cosmos/src/clients/cosmos_client.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ impl CosmosClient {
4848
/// # use std::sync::Arc;
4949
/// use azure_data_cosmos::CosmosClient;
5050
///
51-
/// let credential = Arc::new(azure_identity::DefaultAzureCredential::new().unwrap());
51+
/// let credential = azure_identity::DefaultAzureCredential::new().map(Arc::new).unwrap();
5252
/// let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
5353
/// ```
5454
pub fn new(

sdk/cosmos/azure_data_cosmos/src/clients/database_client.rs

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,10 @@ pub trait DatabaseClientMethods {
2727
/// # Examples
2828
///
2929
/// ```rust,no_run
30-
/// # use std::sync::Arc;
3130
/// # async fn doc() {
32-
/// use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods};
33-
///
34-
/// let credential = Arc::new(azure_identity::DefaultAzureCredential::new().unwrap());
35-
/// let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
36-
/// let db_client = client.database_client("my_database");
37-
/// let response = db_client.read(None)
31+
/// # use azure_data_cosmos::clients::{DatabaseClient, DatabaseClientMethods};
32+
/// # let database_client: DatabaseClient = todo!("this is a non-running example");
33+
/// let response = database_client.read(None)
3834
/// .await.unwrap()
3935
/// .deserialize_body()
4036
/// .await.unwrap();

sdk/cosmos/azure_data_cosmos/src/partition_key.rs

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,8 @@ impl<T: Into<PartitionKey>> From<T> for QueryPartitionStrategy {
2929
/// A single, non-hierarchical, partition key can be specified using the underlying type itself:
3030
///
3131
/// ```rust,no_run
32-
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
33-
/// # let credential = azure_identity::create_default_credential().unwrap();
34-
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
35-
/// # let db_client = client.database_client("my_database");
36-
/// # let container_client = db_client.container_client("my_container");
32+
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
33+
/// # let container_client: ContainerClient = todo!("this is a non-running example");
3734
/// container_client.query_items::<serde_json::Value>(
3835
/// "SELECT * FROM c",
3936
/// "a single string partition key",
@@ -47,11 +44,8 @@ impl<T: Into<PartitionKey>> From<T> for QueryPartitionStrategy {
4744
/// Hierarchical partition keys can be specified using tuples:
4845
///
4946
/// ```rust,no_run
50-
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
51-
/// # let credential = azure_identity::create_default_credential().unwrap();
52-
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
53-
/// # let db_client = client.database_client("my_database");
54-
/// # let container_client = db_client.container_client("my_container");
47+
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
48+
/// # let container_client: ContainerClient = todo!("this is a non-running example");
5549
/// container_client.query_items::<serde_json::Value>(
5650
/// "SELECT * FROM c",
5751
/// ("parent", "child"),
@@ -62,11 +56,8 @@ impl<T: Into<PartitionKey>> From<T> for QueryPartitionStrategy {
6256
/// First, you can use an empty tuple (`()`) anywhere a `PartitionKey` is expected:
6357
///
6458
/// ```rust,no_run
65-
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
66-
/// # let credential = azure_identity::create_default_credential().unwrap();
67-
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
68-
/// # let db_client = client.database_client("my_database");
69-
/// # let container_client = db_client.container_client("my_container");
59+
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
60+
/// # let container_client: ContainerClient = todo!("this is a non-running example");
7061
/// container_client.query_items::<serde_json::Value>(
7162
/// "SELECT * FROM c",
7263
/// (), // A null value in a single-level partition key.
@@ -80,11 +71,8 @@ impl<T: Into<PartitionKey>> From<T> for QueryPartitionStrategy {
8071
/// Or, if you have an [`Option<T>`], for some `T` that is valid as a partition key, it will automatically be serialized as `null` if it has the value [`Option::None`]:
8172
///
8273
/// ```rust,no_run
83-
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
84-
/// # let credential = azure_identity::create_default_credential().unwrap();
85-
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
86-
/// # let db_client = client.database_client("my_database");
87-
/// # let container_client = db_client.container_client("my_container");
74+
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
75+
/// # let container_client: ContainerClient = todo!("this is a non-running example");
8876
/// let my_partition_key: Option<String> = None;
8977
/// container_client.query_items::<serde_json::Value>(
9078
/// "SELECT * FROM c",

0 commit comments

Comments
 (0)