From d1af18acec7b5c8c14119f29abf0c2074cd181eb Mon Sep 17 00:00:00 2001
From: dhilipsiva <dhilipsiva@pm.me>
Date: Tue, 16 Jul 2024 20:46:24 +0530
Subject: [PATCH] docs: Improve code documentation and clippy usage in media
 module

- Add comment explaining the use of `clippy::map_entry` in [packages/media_record/src/media.rs]
- Include link to open issue on Rust Clippy GitHub repo in the comment
---
 packages/media_record/src/media.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/packages/media_record/src/media.rs b/packages/media_record/src/media.rs
index 20dd32a4..78efc8a3 100644
--- a/packages/media_record/src/media.rs
+++ b/packages/media_record/src/media.rs
@@ -63,6 +63,8 @@ impl SessionMediaWriter {
             SessionRecordEvent::TrackMedia(id, media) => {
                 // We allow clippy::map_entry because the suggestion provided by clippy has a bug:
                 // cannot borrow `*self` as mutable more than once at a time
+                // There is a open Issue on the Rust Clippy GitHub Repo:
+                // https://github.com/rust-lang/rust-clippy/issues/11976
                 #[allow(clippy::map_entry)]
                 if !self.tracks.contains_key(&id) {
                     let writer = self.get_free_writer_for(event.ts, media.meta.is_audio());