From 32a02b51e15b40681a2f36476d2b1b745219f417 Mon Sep 17 00:00:00 2001
From: Guillaume Desmottes <guillaume.desmottes@onestream.live>
Date: Tue, 28 Feb 2023 09:48:36 +0100
Subject: [PATCH] utils: streamproducer: document forward_eos default value

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer-rs/-/merge_requests/1226>
---
 gstreamer-utils/src/streamproducer.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/gstreamer-utils/src/streamproducer.rs b/gstreamer-utils/src/streamproducer.rs
index 705063ebc..41128954f 100644
--- a/gstreamer-utils/src/streamproducer.rs
+++ b/gstreamer-utils/src/streamproducer.rs
@@ -235,7 +235,7 @@ impl StreamProducer {
         }
     }
 
-    /// configure if EOS from appsrc should be forwarded to all the consumers
+    /// configure if EOS from appsrc should be forwarded to all the consumers (default: `true`)
     pub fn set_forward_eos(&self, forward_eos: bool) {
         self.consumers.lock().unwrap().forward_eos = forward_eos;
     }