Better documentation on the Examples #3005
Description
The cardano-ledger-test package contains some unit tests that also serve as examples and use cases. They are often not described nearly as well as they could be.
For example:
libs/cardano-ledger-test/src/Test/Cardano/Ledger/Examples/BabbageFeatures.hs:539-543
This examples is labeled as "invalid", which is a bit confusing. This test is testing the core functionality of collateral return outputs, namely that if you have a failed plutus script in a transaction that is marked as IsValid = False, the collateral overflow ends up in the return output. This is confusing because this transaction is actually valid since it is marked as IsValid = False.
Let's go through all the examples and make sure it is clear what each scenario is exhibiting.