From aad114dace7e400d70576d9bb795c6fdee698b57 Mon Sep 17 00:00:00 2001
From: Thomas Braun <tbraun96@gmail.com>
Date: Sun, 6 Oct 2024 09:49:40 -0400
Subject: [PATCH] Add gitguardian file, cleanup

---
 .gitguardian.yaml                             | 19 +++++++++++++++++++
 .../src/prefabs/client/peer_connection.rs     |  5 +----
 .../src/prefabs/client/single_connection.rs   |  9 ++++-----
 3 files changed, 24 insertions(+), 9 deletions(-)
 create mode 100644 .gitguardian.yaml

diff --git a/.gitguardian.yaml b/.gitguardian.yaml
new file mode 100644
index 000000000..39a4412b1
--- /dev/null
+++ b/.gitguardian.yaml
@@ -0,0 +1,19 @@
+version: 2
+
+exit_zero: false
+verbose: false
+instance: https://dashboard.gitguardian.com
+max_commits_for_hook: 50
+allow_self_signed: false # default: false
+
+secret:
+  ignored_paths:
+    - '**/README.md'
+    - 'LICENSE'
+
+  show_secrets: false
+
+  ignore_known_secrets: false
+
+  ignored_detectors:
+    - Generic Password
\ No newline at end of file
diff --git a/citadel_sdk/src/prefabs/client/peer_connection.rs b/citadel_sdk/src/prefabs/client/peer_connection.rs
index eb9bfd93f..6fcb174ff 100644
--- a/citadel_sdk/src/prefabs/client/peer_connection.rs
+++ b/citadel_sdk/src/prefabs/client/peer_connection.rs
@@ -13,10 +13,7 @@ use std::marker::PhantomData;
 use std::sync::Arc;
 use uuid::Uuid;
 
-/// A kernel that connects with the given credentials. If the credentials are not yet registered, then the [`Self::new_register`] function may be used, which will register the account before connecting.
-/// This kernel will only allow outbound communication for the provided account
-///
-/// After establishing a connection to the central node, this kernel then begins connecting to the desired
+/// After establishing a connection to the central node, this kernel begins connecting to the desired
 /// peer(s)
 pub struct PeerConnectionKernel<'a, F, Fut> {
     inner_kernel: Box<dyn NetKernel + 'a>,
diff --git a/citadel_sdk/src/prefabs/client/single_connection.rs b/citadel_sdk/src/prefabs/client/single_connection.rs
index 91906a38a..cc2ff7008 100644
--- a/citadel_sdk/src/prefabs/client/single_connection.rs
+++ b/citadel_sdk/src/prefabs/client/single_connection.rs
@@ -10,10 +10,9 @@ use std::net::SocketAddr;
 use std::sync::Arc;
 use uuid::Uuid;
 
-/// A kernel that connects with the given credentials. If the credentials are not yet registered, then the [`Self::new_register`] function may be used, which will register the account before connecting.
-/// This kernel will only allow outbound communication for the provided account.
-///
-/// This [`NetKernel`] is the base kernel type for other built-in implementations of [`NetKernel`]
+/// This [`SingleClientServerConnectionKernel`] is the base kernel type for other built-in implementations of [`NetKernel`].
+/// It establishes connections to a central node for purposes of NAT traversal and peer discovery, and depending on the application layer,
+/// can leverage the client to server connection for other purposes that require communication between the two.
 pub struct SingleClientServerConnectionKernel<F, Fut> {
     handler: Mutex<Option<F>>,
     udp_mode: UdpMode,
@@ -51,7 +50,7 @@ where
     Fut: Future<Output = Result<(), NetworkError>> + Send,
 {
     /// Creates a new [`SingleClientServerConnectionKernel`] with the given settings.
-    /// The [`ServerConnectionSettings`] must be provided, and the [`on_channel_received`] function will be called when the connection is established.
+    /// The [`ServerConnectionSettings`] must be provided, and the `on_channel_received` function will be called when the connection is established.
     pub fn new(settings: ServerConnectionSettings, on_channel_received: F) -> Self {
         let (udp_mode, session_security_settings) =
             (settings.udp_mode(), settings.session_security_settings());