Added examples of transaction creation to Haddock

[palas]

Changelog

- description: |
    Added example of transaction creation with traditional and experimental APIs to Haddock.
  type:
  - test
  - documentation

Context

Prompted by this slack discussion

How to trust this PR

Have a read of the haddock.

Checklist

• Commit sequence broadly makes sense and commits have useful messages
• New tests are added if needed and existing tests are updated. See Running tests for more details
• Self-reviewed the diff

[Jimbo4350]

Nice work 👍 . I would move the transaction creation haddocks to Cardano.Api.Experimental.Tx and point to it from here.

[Jimbo4350]

So I think this is a bad UI. We should have a defaultTxBodyContent defined in an experimental module:

defaultTxBodyContent
  :: ()
  => Era era
  -> TxBodyContent BuildTx era

We want to avoid mixing the old api and the new api (but obviously allow for migration e.g via convert).

These haddocks are excellent but what we should do is have haddocks strictly describing the old api, the new api and how to migrate from the old to the new.

[Jimbo4350]

Getting there 👍

[carbolymer]

Outside of the scope of this PR: Maybe could use doctest to make sure that haddock examples didn't bitrot?

[palas]

Outside of the scope of this PR: Maybe could use doctest to make sure that haddock examples didn't bitrot?

Yes, I was thinking the same. Currently it is not checked by the CI, but at least it is easy to update if we do. And I made a couple of examples using this format in a different PR already (unrelated).