From d30d9b9c902ac590787af04fc2057c5369650b8b Mon Sep 17 00:00:00 2001
From: Ottatop <ottatop1227@gmail.com>
Date: Sun, 14 Jul 2024 18:53:17 -0500
Subject: [PATCH] api/rust: Update docs

---
 api/rust/src/lib.rs      | 31 +++++++++++++++++++++----------
 api/rust/src/pinnacle.rs |  8 ++------
 2 files changed, 23 insertions(+), 16 deletions(-)

diff --git a/api/rust/src/lib.rs b/api/rust/src/lib.rs
index dd0cf6b..18685d9 100644
--- a/api/rust/src/lib.rs
+++ b/api/rust/src/lib.rs
@@ -45,7 +45,7 @@
 //! ```
 //!
 //! ## 3. Set up dependencies
-//! In your `Cargo.toml`, add a dependency to `pinnacle-api`:
+//! In your `Cargo.toml`, add `pinnacle-api` as a dependency:
 //!
 //! ```toml
 //! # Cargo.toml
@@ -56,21 +56,32 @@
 //!
 //! ## 4. Set up the main function
 //! In `main.rs`, change `fn main()` to `async fn main()` and annotate it with the
-//! [`pinnacle_api::config`][`crate::config`] macro. Create the API modules with
-//! [`ApiModules::new`]:
+//! [`pinnacle_api::config`][`crate::config`] macro:
+//!
+//! ```
+//! #[pinnacle_api::config]
+//! async fn main() {}
+//! ```
+//!
+//! ## 5. Begin crafting your config!
+//!
+//! You can create the API modules with [`ApiModules::new`]:
 //!
 //! ```
 //! use pinnacle_api::ApiModules;
 //!
-//! #[pinnacle_api::config]
-//! async fn main() {
-//!     let ApiModules {
-//!         ..
-//!     } = ApiModules::new();
-//! }
+//! let ApiModules {
+//!     ..
+//! } = ApiModules::new();
+//! ```
+//!
+//! Most modules are copy-able unit structs, so you can also use them directly:
+//!
+//! ```
+//! let _ = pinnacle_api::window::Window.get_all();
+//! pinnacle_api::pinnacle::Pinnacle.quit();
 //! ```
 //!
-//! ## 5. Begin crafting your config!
 //! You can peruse the documentation for things to configure.
 
 use futures::{Future, StreamExt};
diff --git a/api/rust/src/pinnacle.rs b/api/rust/src/pinnacle.rs
index 99789ec..32e11d8 100644
--- a/api/rust/src/pinnacle.rs
+++ b/api/rust/src/pinnacle.rs
@@ -8,15 +8,11 @@
 
 use std::time::Duration;
 
-use pinnacle_api_defs::pinnacle::{
-    v0alpha1::{
-        PingRequest, QuitRequest, ReloadConfigRequest, ShutdownWatchRequest, ShutdownWatchResponse,
-    },
-    window::v0alpha1::SetFocusedRequest,
+use pinnacle_api_defs::pinnacle::v0alpha1::{
+    PingRequest, QuitRequest, ReloadConfigRequest, ShutdownWatchRequest, ShutdownWatchResponse,
 };
 use rand::RngCore;
 use tonic::{Request, Streaming};
-use tracing::error;
 
 use crate::{block_on_tokio, pinnacle};