Skip to content

Commit

Permalink
simplify doctests that don't run using panic!()
Browse files Browse the repository at this point in the history
  • Loading branch information
@analogrelay
analogrelay authored Sep 26, 2024
1 parent 904c66c commit 5205efb
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 43 deletions.
21 changes: 6 additions & 15 deletions sdk/cosmos/azure_data_cosmos/src/clients/container_client.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,8 @@ pub trait ContainerClientMethods {
///
/// ```rust,no_run
/// # async fn doc() {
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
/// # let credential = azure_identity::create_default_credential().unwrap();
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
/// # let db_client = client.database_client("my_database");
/// # let container_client = db_client.container_client("my_container");
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
/// # let container_client: ContainerClient = todo!("this is a non-running example");
/// let response = container_client.read(None)
/// .await.unwrap()
/// .deserialize_body()
Expand Down Expand Up @@ -71,11 +68,8 @@ pub trait ContainerClientMethods {
///
/// ```rust,no_run
/// # async fn doc() {
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
/// # let credential = azure_identity::create_default_credential().unwrap();
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
/// # let db_client = client.database_client("my_database");
/// # let container_client = db_client.container_client("my_container");
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
/// # let container_client: ContainerClient = todo!("this is a non-running example");
/// #[derive(serde::Deserialize)]
/// struct Customer {
/// id: u64,
Expand All @@ -92,11 +86,8 @@ pub trait ContainerClientMethods {
///
/// ```rust,no_run
/// # async fn doc() {
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods, Query};
/// # let credential = azure_identity::create_default_credential().unwrap();
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
/// # let db_client = client.database_client("my_database");
/// # let container_client = db_client.container_client("my_container");
/// # use azure_data_cosmos::{Query, clients::{ContainerClient, ContainerClientMethods}};
/// # let container_client: ContainerClient = todo!("this is a non-running example");
/// #[derive(serde::Deserialize)]
/// struct Customer {
/// id: u64,
Expand Down
2 changes: 1 addition & 1 deletion sdk/cosmos/azure_data_cosmos/src/clients/cosmos_client.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ impl CosmosClient {
/// # use std::sync::Arc;
/// use azure_data_cosmos::CosmosClient;
///
/// let credential = Arc::new(azure_identity::DefaultAzureCredential::new().unwrap());
/// let credential = azure_identity::DefaultAzureCredential::new().map(Arc::new).unwrap();
/// let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
/// ```
pub fn new(
Expand Down
10 changes: 3 additions & 7 deletions sdk/cosmos/azure_data_cosmos/src/clients/database_client.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,10 @@ pub trait DatabaseClientMethods {
/// # Examples
///
/// ```rust,no_run
/// # use std::sync::Arc;
/// # async fn doc() {
/// use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods};
///
/// let credential = Arc::new(azure_identity::DefaultAzureCredential::new().unwrap());
/// let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
/// let db_client = client.database_client("my_database");
/// let response = db_client.read(None)
/// # use azure_data_cosmos::clients::{DatabaseClient, DatabaseClientMethods};
/// # let database_client: DatabaseClient = todo!("this is a non-running example");
/// let response = database_client.read(None)
/// .await.unwrap()
/// .deserialize_body()
/// .await.unwrap();
Expand Down
28 changes: 8 additions & 20 deletions sdk/cosmos/azure_data_cosmos/src/partition_key.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,8 @@ impl<T: Into<PartitionKey>> From<T> for QueryPartitionStrategy {
/// A single, non-hierarchical, partition key can be specified using the underlying type itself:
///
/// ```rust,no_run
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
/// # let credential = azure_identity::create_default_credential().unwrap();
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
/// # let db_client = client.database_client("my_database");
/// # let container_client = db_client.container_client("my_container");
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
/// # let container_client: ContainerClient = todo!("this is a non-running example");
/// container_client.query_items::<serde_json::Value>(
/// "SELECT * FROM c",
/// "a single string partition key",
Expand All @@ -47,11 +44,8 @@ impl<T: Into<PartitionKey>> From<T> for QueryPartitionStrategy {
/// Hierarchical partition keys can be specified using tuples:
///
/// ```rust,no_run
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
/// # let credential = azure_identity::create_default_credential().unwrap();
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
/// # let db_client = client.database_client("my_database");
/// # let container_client = db_client.container_client("my_container");
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
/// # let container_client: ContainerClient = todo!("this is a non-running example");
/// container_client.query_items::<serde_json::Value>(
/// "SELECT * FROM c",
/// ("parent", "child"),
Expand All @@ -62,11 +56,8 @@ impl<T: Into<PartitionKey>> From<T> for QueryPartitionStrategy {
/// First, you can use an empty tuple (`()`) anywhere a `PartitionKey` is expected:
///
/// ```rust,no_run
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
/// # let credential = azure_identity::create_default_credential().unwrap();
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
/// # let db_client = client.database_client("my_database");
/// # let container_client = db_client.container_client("my_container");
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
/// # let container_client: ContainerClient = todo!("this is a non-running example");
/// container_client.query_items::<serde_json::Value>(
/// "SELECT * FROM c",
/// (), // A null value in a single-level partition key.
Expand All @@ -80,11 +71,8 @@ impl<T: Into<PartitionKey>> From<T> for QueryPartitionStrategy {
/// 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`]:
///
/// ```rust,no_run
/// # use azure_data_cosmos::{CosmosClient, CosmosClientMethods, clients::DatabaseClientMethods, clients::ContainerClientMethods};
/// # let credential = azure_identity::create_default_credential().unwrap();
/// # let client = CosmosClient::new("https://myaccount.documents.azure.com/", credential, None).unwrap();
/// # let db_client = client.database_client("my_database");
/// # let container_client = db_client.container_client("my_container");
/// # use azure_data_cosmos::clients::{ContainerClient, ContainerClientMethods};
/// # let container_client: ContainerClient = todo!("this is a non-running example");
/// let my_partition_key: Option<String> = None;
/// container_client.query_items::<serde_json::Value>(
/// "SELECT * FROM c",
Expand Down

0 comments on commit 5205efb

Please sign in to comment.