Skip to content

Extend haddock docs #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Extend haddock docs #208

wants to merge 1 commit into from

Conversation

gilligan
Copy link
Collaborator

Add haddock comments for

  • AlwaysFailingScripts
  • AlwaysPassingScripts
  • Utils

Prereview checklist

  • Changes have been documented by running changie new
  • All tests pass in CI
  • PR was self-reviewed

Add haddock comments for

- AlwaysFailingScripts
- AlwaysPassingScripts
- Utils
Comment on lines +52 to +53
-- This wraps the result in a unit via 'check', which throws an error when given 'False'.
-- Suitable for compilation into on-chain code.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a pattern that each and every Plutus script follows, I don't think this belongs here.

Comment on lines +52 to +53
(UnsafeFromData a) =>
-- \| Error message used if the list is not a singleton.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know haddock well enough or this is a typo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants