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

Documented the Twiddler module #3073

Merged
merged 1 commit into from
Oct 20, 2022
Merged

Documented the Twiddler module #3073

merged 1 commit into from
Oct 20, 2022

Conversation

Soupstraw
Copy link
Contributor

@Soupstraw Soupstraw commented Oct 11, 2022

This PR adds documentation to the Twiddle module.

I also devised a law for Twiddle instances and wrote some tests that test that law.

closes #3067

@Soupstraw Soupstraw requested review from lehins and TimSheard and removed request for lehins October 11, 2022 12:58
@Soupstraw Soupstraw force-pushed the jj/document-twiddle branch 4 times, most recently from fe06283 to c30043a Compare October 11, 2022 13:06
@Soupstraw Soupstraw marked this pull request as ready for review October 11, 2022 13:06
@Soupstraw Soupstraw force-pushed the jj/document-twiddle branch 3 times, most recently from ff9e55f to e6d9eb5 Compare October 11, 2022 15:33
@Soupstraw Soupstraw marked this pull request as draft October 11, 2022 16:00
Copy link
Collaborator

@lehins lehins left a comment

Choose a reason for hiding this comment

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

Minor suggestions

@lehins
Copy link
Collaborator

lehins commented Oct 11, 2022

@Soupstraw FYI I didn't appprove the PR, since it is still marked as "draft". I wasn't sure if you plan to add more to this PR.

Also ormolu CI fails

@Soupstraw
Copy link
Contributor Author

Yes, I figured I'll add some tests for the Twiddle invariant, should be ready to merge later today.

@Soupstraw Soupstraw force-pushed the jj/document-twiddle branch 4 times, most recently from ac3dd05 to e0ca2dc Compare October 12, 2022 14:24
@Soupstraw Soupstraw marked this pull request as ready for review October 12, 2022 14:25
@Soupstraw Soupstraw force-pushed the jj/document-twiddle branch 2 times, most recently from a01a716 to 5dd714f Compare October 12, 2022 15:01
@Soupstraw
Copy link
Contributor Author

It's failing the probabilistic tests again..

@Soupstraw Soupstraw changed the title Documented the Twiddler module. Documented the Twiddler module Oct 14, 2022
@teodanciu
Copy link
Contributor

Great documentation, I finally I understand the Twiddler :D

Copy link
Contributor

@JaredCorduan JaredCorduan left a comment

Choose a reason for hiding this comment

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

I agree with @teodanciu , this looks great! I also really love the new tests!!

Copy link
Collaborator

@lehins lehins left a comment

Choose a reason for hiding this comment

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

Look great. However, this PR was suppose to be about documentation, right? 😉 Adding actual property tests should be done in a separate PR.

libs/cardano-ledger-test/cardano-ledger-test.cabal Outdated Show resolved Hide resolved
libs/cardano-data/src/Data/Orphans.hs Outdated Show resolved Hide resolved
@Soupstraw Soupstraw force-pushed the jj/document-twiddle branch 2 times, most recently from 49ef3d8 to f48bca0 Compare October 20, 2022 11:19
Copy link
Collaborator

@lehins lehins left a comment

Choose a reason for hiding this comment

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

👍

@Soupstraw Soupstraw force-pushed the jj/document-twiddle branch from f48bca0 to b551bd7 Compare October 20, 2022 13:02
@lehins lehins merged commit 5f80a3c into master Oct 20, 2022
@iohk-bors iohk-bors bot deleted the jj/document-twiddle branch October 20, 2022 20:06
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.

Document the Twiddle module
4 participants