chore: fix docstring

racoonframework · Jun 7, 2024 · a1f8472 · a1f8472
1 parent 3f0ad15
commit a1f8472
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 11 deletions.
diff --git a/src/core/session/managers.rs b/src/core/session/managers.rs
@@ -21,12 +21,16 @@ use crate::racoon_error;
 /// # Examples
 ///
 /// ```
-/// use racoon::core::session::managers::FileSessonManager;
+/// use std::env;
 ///
-/// // Optional
-/// env::set_var("SESSION_FILE_PATH", "../mydb/session");
+/// use racoon::core::session::managers::FileSessionManager;
 ///
-/// let session_manager = FileSessonManager::new().await;
+/// #[tokio::main]
+/// async fn main() {
+///   // Optional
+///   env::set_var("SESSION_FILE_PATH", "../mydb/session");
+///   let session_manager = FileSessionManager::new().await;
+/// }
 /// ```
 ///
 /// The file path can be specified by specifying `SESSION_FILE_PATH` in environment variable.

diff --git a/src/core/session/mod.rs b/src/core/session/mod.rs
@@ -63,8 +63,12 @@ impl Session {
     ///
     /// # Examples
     /// ```
-    /// let session = request.session;
-    /// let _ = session.set("name", "John").await;
+    /// use racoon::core::request::Request;
+    ///
+    /// async fn home(request: Request) {
+    ///   let session = request.session; 
+    ///   let _ = session.set("name", "John").await;
+    /// }
     /// ```
     ///
     pub async fn set<S: AsRef<str>>(&self, name: S, value: S) -> std::io::Result<()> {
@@ -85,13 +89,17 @@ impl Session {
     ///
     /// # Examples
     /// ```
-    /// let session = request.session;
-    /// let name = session.get("name").await;
+    /// use racoon::core::request::Request;
+    ///
+    /// async fn home(request: Request) {
+    ///   let session = request.session;
+    ///   let name = session.get("name").await;
+    /// }
     /// ```
     ///
     /// This method does not return or print any error message by default.
     /// ```
-    /// use racoon:core:server::Server;
+    /// use racoon::core::server::Server;
     ///
     /// // Enable debugging
     /// Server::enable_logging();
@@ -108,8 +116,12 @@ impl Session {
     ///
     /// # Examples
     /// ```
-    /// let session = request.session;
-    /// let _ = session.remove("name").await;
+    /// use racoon::core::request::Request;
+    ///
+    /// async fn home(request: Request) {
+    ///   let session = request.session;
+    ///   let _ = session.remove("name").await;
+    /// }
     /// ```
     ///
     pub async fn remove<S: AsRef<str>>(&self, name: S) -> std::io::Result<()> {