Skip to content

Commit

Permalink
docs: create module aliases for backward compatibility (#182)
Browse files Browse the repository at this point in the history
  • Loading branch information
favonia authored Oct 31, 2024
1 parent 4024850 commit f1a58c1
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
2 changes: 2 additions & 0 deletions src/Asai.ml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 9 additions & 3 deletions src/Asai.mli
Original file line number Diff line number Diff line change
Expand Up @@ -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. *)
Expand All @@ -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

Expand Down

0 comments on commit f1a58c1

Please sign in to comment.