Add a warning to the haddock of asNaturalHKD

lehins · Soupstraw · commit b07ea85aa7c0 · 2025-07-14T09:35:42.000Z
diff --git a/eras/conway/impl/src/Cardano/Ledger/Conway/PParams.hs b/eras/conway/impl/src/Cardano/Ledger/Conway/PParams.hs
@@ -1241,6 +1241,8 @@ conwayModifiedPPGroups
       , ppGroup p31
       ]
 
+-- | Care should be taken to not apply this function to signed values, otherwise it will result in
+-- an `ArithmeticUnderflow` exception for negative numbers.
 asNaturalHKD :: forall f i. (HKDFunctor f, Integral i) => HKD f i -> HKD f Natural
 asNaturalHKD = hkdMap (Proxy @f) (fromIntegral @i @Natural)
 

Original file line number	Diff line number	Diff line change
`@@ -1241,6 +1241,8 @@ conwayModifiedPPGroups`
`1241`	`1241`	`, ppGroup p31`
`1242`	`1242`	`]`
`1243`	`1243`
	`1244`	`+-- \| Care should be taken to not apply this function to signed values, otherwise it will result in`
	`1245`	+-- an `ArithmeticUnderflow` exception for negative numbers.
`1244`	`1246`	`asNaturalHKD :: forall f i. (HKDFunctor f, Integral i) => HKD f i -> HKD f Natural`
`1245`	`1247`	`asNaturalHKD = hkdMap (Proxy @f) (fromIntegral @i @Natural)`
`1246`	`1248`