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.

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

Document copyRecord guarantees #3955

Merged
merged 1 commit into from
Oct 13, 2021
Merged

Conversation

erights
Copy link
Member

@erights erights commented Oct 12, 2021

@jessysaurusrex I'm including you, because my intention is that, once we follow the advice on this page, that this page is helpful for reviewers auditing code using this kind of input validation.

In a peculiar way, this is a start on a semantics of our distributed object system. But it is inside out precisely to focus on the meaning of these checks as input validation.

Copy link
Member

@michaelfig michaelfig left a comment

Choose a reason for hiding this comment

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

Good stuff. It really needs a compelling name, though, so I'll not go so far as to approve, but won't block other approvals.

packages/marshal/docs/copyRecord-guarantees.md Outdated Show resolved Hide resolved
packages/marshal/docs/copyRecord-guarantees.md Outdated Show resolved Hide resolved
Copy link
Contributor

@katelynsills katelynsills left a comment

Choose a reason for hiding this comment

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

This looks good to me! One question: should this explanation also explain what a Structure is, and how to assert that? Amounts must be Structures (no promises). Maybe just a sentence explanation and link to information on structures?

@erights
Copy link
Member Author

erights commented Oct 13, 2021

This looks good to me! One question: should this explanation also explain what a Structure is, and how to assert that? Amounts must be Structures (no promises). Maybe just a sentence explanation and link to information on structures?

This part is about to change again. I'll wait until it settles down.

@erights erights force-pushed the markm-explain-copyRecord-validation branch from c8ee4a3 to 4398b4b Compare October 13, 2021 03:44
@erights erights added the automerge:squash Automatically squash merge label Oct 13, 2021
@erights erights force-pushed the markm-explain-copyRecord-validation branch from 4398b4b to 6b13a39 Compare October 13, 2021 04:26
@mergify mergify bot merged commit f4a0ba1 into master Oct 13, 2021
@mergify mergify bot deleted the markm-explain-copyRecord-validation branch October 13, 2021 04:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge:squash Automatically squash merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants