Add module comment

gtk-rs · Oct 26, 2023 · 020f029 · 020f029
1 parent 1a31817
commit 020f029
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/glib/src/regex.rs b/glib/src/regex.rs
@@ -1,5 +1,8 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
+//! This module is inefficient and should not be used by Rust programs except for
+//! compatibility with GLib.Regex based APIs.
+
 use crate::{translate::*, IntoGStr, MatchInfo, Regex, RegexCompileFlags, RegexMatchFlags};
 use std::{mem, ptr};