Skip to content

Commit 9e3cbf0

Browse files
committed
update docs based on comments
1 parent 565f16e commit 9e3cbf0

1 file changed

Lines changed: 10 additions & 30 deletions

File tree

cot-macros/src/lib.rs

Lines changed: 10 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,11 @@ pub fn derive_model_helper(_item: TokenStream) -> TokenStream {
236236
/// is_active: bool
237237
/// }
238238
///
239-
/// let query = query!(Customer, $id == 5 && $full_name == "Jon Doe");
239+
/// # async fn run(db: Database) -> cot::Result<()> {
240+
/// let customer = query!(Customer, $id > 5 && $full_name == "Jon Doe").await?;
241+
/// println!("Customer: {:?}", customer);
242+
/// # Ok(())
243+
/// # }
240244
/// ```
241245
///
242246
/// In the example above, `$id` and `$full_name` refer to fields on the
@@ -256,8 +260,7 @@ pub fn derive_model_helper(_item: TokenStream) -> TokenStream {
256260
/// # id: i32,
257261
/// # full_name: String,
258262
/// # }
259-
/// let _ = query!(Customer, $id);
260-
/// let _ = query!(Customer, $full_name);
263+
/// let _ = query!(Customer, $id == 5);
261264
/// ```
262265
///
263266
/// ## Literal values
@@ -312,10 +315,10 @@ pub fn derive_model_helper(_item: TokenStream) -> TokenStream {
312315
/// # stock: i32,
313316
/// # quantity: i32,
314317
/// # }
315-
/// let _ = query!(Customer, $price + 10);
316-
/// let _ = query!(Customer, $stock - 1);
317-
/// let _ = query!(Customer, $quantity * 2);
318-
/// let _ = query!(Customer, $price / 2);
318+
/// let _ = query!(Customer, $price + 10 > 20);
319+
/// let _ = query!(Customer, $stock - 1 == 20);
320+
/// let _ = query!(Customer, $quantity * 2 < 100);
321+
/// let _ = query!(Customer, $price / 2 != $quantity);
319322
/// ```
320323
///
321324
/// ## Rust-side value expressions
@@ -352,29 +355,6 @@ pub fn derive_model_helper(_item: TokenStream) -> TokenStream {
352355
/// let _ = query!(Customer, $id == next_customer_id());
353356
/// ```
354357
///
355-
/// # Executing a query
356-
///
357-
/// `query!` builds a query. To execute it and retrieve results, call a terminal
358-
/// query method such as [`Query::get`] or [`Query::all`].
359-
///
360-
/// ```
361-
/// use cot::db::{Database, model, query};
362-
///
363-
/// #[model]
364-
/// #[derive(Debug, Clone)]
365-
/// struct Customer {
366-
/// #[model(primary_key)]
367-
/// id: i32,
368-
/// full_name: String,
369-
/// }
370-
///
371-
/// # async fn run(db: Database) -> cot::Result<()> {
372-
/// let customer = query!(Customer, $id == 5).get(&db).await?;
373-
/// println!("Customer: {:?}", customer);
374-
/// # Ok(())
375-
/// # }
376-
/// ```
377-
///
378358
/// [`Query`]: query/struct.Query.html
379359
/// [`Query::get`]: query/Struct.Query.html#method.get
380360
/// [`Query::all`]: query/Struct.Query.html#method.all

0 commit comments

Comments
 (0)