From e9cd5813aee306f4009c5e34522289f33ac18dc5 Mon Sep 17 00:00:00 2001
From: --show-origin <paul.michelle.prod@gmail.com>
Date: Mon, 22 Apr 2024 18:37:36 +0500
Subject: [PATCH] Update private docs for ClientOptions

---
 src/proto/client/options.rs | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

diff --git a/src/proto/client/options.rs b/src/proto/client/options.rs
index 98fa58ae..f13c8a82 100644
--- a/src/proto/client/options.rs
+++ b/src/proto/client/options.rs
@@ -2,22 +2,32 @@ use crate::proto::WorkerId;
 
 #[derive(Clone, Debug)]
 pub(crate) struct ClientOptions {
-    // Hostname to advertise to server. Defaults to machine hostname.
+    /// Hostname to advertise to server.
+    ///
+    /// Defaults to machine hostname.
     pub(crate) hostname: Option<String>,
 
-    // PID to advertise to server. Defaults to process ID.
+    /// PID to advertise to server.
+    ///
+    /// Defaults to process ID.
     pub(crate) pid: Option<usize>,
 
-    // Worker ID to advertise to server Defaults to a GUID.
+    /// Worker ID to advertise to server.
+    /// 
+    /// Defaults to a GUID.
     pub(crate) wid: Option<WorkerId>,
 
-    // Labels to advertise to server. Defaults to ["rust"].
+    /// Labels to advertise to server.
+    ///
+    /// Defaults to ["rust"].
     pub(crate) labels: Vec<String>,
 
-    // Password to authenticate with. Defaults to None.
+    /// Password to authenticate with.
+    /// 
+    /// Defaults to None.
     pub(crate) password: Option<String>,
 
-    // Whether this client is instatianted for a worker (i.e. to consume jobs).
+    /// Whether this client is instatianted for a worker (i.e. to consume jobs).
     pub(crate) is_worker: bool,
 }