Document unsafe operations of AssocMap
#5838
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ana Pantilie <[email protected]>
Signed-off-by: Ana Pantilie <[email protected]>
Signed-off-by: Ana Pantilie <[email protected]>
Signed-off-by: Ana Pantilie <[email protected]>
zliu41
reviewed
Mar 17, 2024
plutus-tx/src/PlutusTx/AssocMap.hs
Outdated
| -- have been checked to not contain duplicate pairs or duplicate keys, otherwise the 'Map' invariant | ||
| -- will be broken. As usual, the "keys" are considered to be the first element of the pair. | ||
| unsafeFromList :: [(k, v)] -> Map k v | ||
| unsafeFromList = Map | ||
|
|
||
| {-# INLINEABLE fromListSafe #-} |
There was a problem hiding this comment.
If the other one is called unsafeFromList, it's better to call this one safeFromList.
plutus-tx/src/PlutusTx/AssocMap.hs
Outdated
| fromList = Map | ||
| {-# INLINEABLE unsafeFromList #-} | ||
| -- | Unsafely create a 'Map' from a list of pairs. This should _only_ be applied to lists which | ||
| -- have been checked to not contain duplicate pairs or duplicate keys, otherwise the 'Map' invariant |
There was a problem hiding this comment.
- "duplicate pairs or duplicate keys" - is it not enough to just say "duplicate keys"?
- It may not be obvious what "the 'Map' invariant will be broken" means. I think it's worth elaborating a bit.
| @@ -53,15 +53,13 @@ import GHC.Generics (Generic) | |||
| import Language.Haskell.TH.Syntax as TH (Lift) | |||
| import Prettyprinter (Pretty (..)) | |||
|
|
|||
| {- HLINT ignore "Use newtype instead of data" -} | |||
|
|
|||
| -- See Note [Optimising Value]. | |||
| -- | A 'Map' of key-value pairs. | |||
| newtype Map k v = Map {unMap :: [(k, v)]} | |||
There was a problem hiding this comment.
Can you expand the Haddock of the Map type to summarize which operations are unsafe? Otherwise people may miss the Haddock on the instances.
Signed-off-by: Ana Pantilie <[email protected]>
Signed-off-by: Ana Pantilie <[email protected]>
Lucsanszky
added a commit
to IntersectMBO/cardano-ledger
that referenced
this pull request
Apr 8, 2024
`fromList` was deprecated in `1.24.0.0` by IntersectMBO/plutus#5838
lehins
pushed a commit
to IntersectMBO/cardano-ledger
that referenced
this pull request
Apr 8, 2024
`fromList` was deprecated in `1.24.0.0` by IntersectMBO/plutus#5838
Lucsanszky
added a commit
to IntersectMBO/cardano-ledger
that referenced
this pull request
Apr 8, 2024
`fromList` was deprecated in `1.24.0.0` by IntersectMBO/plutus#5838
lehins
pushed a commit
to IntersectMBO/cardano-ledger
that referenced
this pull request
Apr 9, 2024
* Plutus 1.25.0.0 * Replace `fromList` with `unsafeFromList` `fromList` was deprecated in `1.24.0.0` by IntersectMBO/plutus#5838 * Bump patch versions --------- Co-authored-by: Lucsanszky <[email protected]> Co-authored-by: Lucsanszky <[email protected]>
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pre-submit checklist: