From 7526ea46261dc1dcf0e3192ff539180fb4f89b57 Mon Sep 17 00:00:00 2001
From: favonia <favonia@gmail.com>
Date: Thu, 31 Oct 2024 08:55:38 -0500
Subject: [PATCH] docs: create aliases for backward compatibility

---
 src/Asai.ml  |  2 ++
 src/Asai.mli | 12 +++++++++---
 2 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/src/Asai.ml b/src/Asai.ml
index 30b1e3c..284e279 100644
--- a/src/Asai.ml
+++ b/src/Asai.ml
@@ -4,7 +4,9 @@ module Loctext = Loctext
 module Diagnostic = Diagnostic
 module Reporter = Reporter
 module Structured_reporter = Structured_reporter
+module StructuredReporter = Structured_reporter
 module Minimum_signatures = Minimum_signatures
+module MinimumSigs = Minimum_signatures
 
 module Tty = Tty
 module Github = Github
diff --git a/src/Asai.mli b/src/Asai.mli
index 9527b03..ce0009a 100644
--- a/src/Asai.mli
+++ b/src/Asai.mli
@@ -27,19 +27,19 @@ module Reporter = Reporter
 
 (** Generating and handling diagnostics using algebraic effects. The API is optimized for fully structured messages.
 
-    @since 0.2.0 *)
+    @since 0.4.0 (renamed from StructuredReporter) *)
 module Structured_reporter = Structured_reporter
 
 (** Signatures that specify the minimum interface for libraries, applications, and handlers to work together.
 
-    @since 0.3.0 *)
+    @since 0.4.0 (renamed from MinimumSigs) *)
 module Minimum_signatures = Minimum_signatures
 
 (** {1 Experimental Diagnostic Handlers} *)
 
 (** These handlers are subject to changes, but we will minimize incompatible changes between minor versions. *)
 
-(** Diagnostic display for UNIX terminals. *)
+(** Diagnostic display for terminals. *)
 module Tty = Tty
 
 (** GitHub Actions workflow commands. *)
@@ -60,6 +60,12 @@ module Source_reader = Source_reader
 
 (**/**)
 
+(** Backward compatibility *)
+module StructuredReporter = Structured_reporter [@@ocaml.alert deprecated "Use Asai.Structured_reporter instead"]
+
+(** Backward compatibility *)
+module MinimumSigs = Minimum_signatures [@@ocaml.alert deprecated "Use Asai.Minimum_signatures instead"]
+
 (** Helper functions for handling user content. This is exposed for internal testing. Absolutely no stability guarantees. *)
 module String_utils = String_utils