Skip to content

Commit 44ac1d8

Browse files
committed
docs(eras): add deprecation notice for era case functions
1 parent de7b192 commit 44ac1d8

File tree

1 file changed

+9
-0
lines changed
  • cardano-api/src/Cardano/Api/Era/Internal

1 file changed

+9
-0
lines changed

cardano-api/src/Cardano/Api/Era/Internal/Case.hs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@
33
{-# LANGUAGE LambdaCase #-}
44
{-# LANGUAGE RankNTypes #-}
55

6+
-- | Era case functions for branching on era types
7+
--
8+
-- DEPRECATION NOTICE: The @case*@ functions in this module are deprecated and will be
9+
-- removed in a future release. They were used for era-based conditional logic but are
10+
-- being phased out in favor of direct pattern matching or other approaches.
11+
--
12+
-- DO NOT add new @case*@ functions to this module. If you need era-based branching,
13+
-- prefer direct pattern matching on era witnesses or use the conversion functions
14+
-- provided by the era system.
615
module Cardano.Api.Era.Internal.Case
716
( -- Case on CardanoEra
817
caseByronOrShelleyBasedEra

0 commit comments

Comments
 (0)