Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Adding some minimal example documentation #4

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Adding some minimal example documentation #4

wants to merge 4 commits into from

Conversation

Ali-Hill
Copy link
Collaborator

No description provided.

@Ali-Hill Ali-Hill force-pushed the alasdair-minimal-example-documentation-1 branch from d1a6a03 to 5488ee1 Compare September 19, 2023 10:56
RSoulatIOHK
RSoulatIOHK requested changes Sep 25, 2023
View reviewed changes
Copy link
Owner

@RSoulatIOHK RSoulatIOHK left a comment

Choose a reason for hiding this comment

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

Overall great for plutus-apps. Do you want to have cooked and plutus-apps in one doc?

If so, I made some comments about that. Otherwise, just specify at the beginning that this is the doc for the plutus-apps BE.

docs/backend/certification-object.md Outdated

**No Locked Funds Light**

This property tests that funds locked in the contract can be retrieved but allows for cooperation between wallets.
Copy link
Owner

Choose a reason for hiding this comment

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

allows or requires?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think allows as you can use the same strategy that satisfies NoLockedFunds to satisfy NoLockedFundsLight but not the other way around

docs/backend/certification-object.md Outdated

**Crash Tolerance**

This property tests to see if a contract instance can be restarted in the event of a crash and whether once restarted the contract still behaves as expected by the model.
Copy link
Owner

Choose a reason for hiding this comment

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

Which part of the contract crashes and restarts?

docs/backend/certification-object.md Outdated

The standard property test runs the model against an emulator to check to see if there are any discrepencies between the model and emulator.

**No Locked Funds**
Copy link
Owner

Choose a reason for hiding this comment

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

Maybe have a note that say for which backend the properties are available

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have linked to the intro page table now

docs/backend/certification-object.md Outdated

This property tests that funds locked in the contract can be retrieved by any wallet without cooperation from any other wallets.

**No Locked Funds Light**
Copy link
Owner

Choose a reason for hiding this comment

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

Maybe have a note that say for which backend the properties are available

docs/backend/certification-object.md Outdated

**Remark on Properties**

You may notice that there are more properties than there are fields in the certification object. This is because a certification will automatically run the standard property test and double satisfaction test by default. At the moment double satisfaction is temporarily disabled.
Copy link
Owner

Choose a reason for hiding this comment

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

Maybe specify for which backend it has been deactivated. which probably imply that we need to have somewhere which BE we support.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

docs/backend/certification-object.md Outdated

This property tests to see if a contract instance can be restarted in the event of a crash and whether once restarted the contract still behaves as expected by the model.

**Double Satisfaction**
Copy link
Owner

Choose a reason for hiding this comment

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

Maybe have a note that say for which backend the properties are available

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

docs/backend/certification-object.md Outdated

The following explanations refer to the Escrow [Contract Model Tutorial](https://plutus-apps.readthedocs.io/en/latest/plutus/tutorials/contract-models.html):

``certCoverageIndex``
Copy link
Owner

Choose a reason for hiding this comment

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

Maybe have a note that say for which backend this is currently available

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RSoulatIOHK RSoulatIOHK RSoulatIOHK approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Ali-Hill @RSoulatIOHK