Skip to content
New issue

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

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

Already on GitHub? # to your account

An attempt at better documentation for q-d #73

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

ghost
Copy link

@ghost ghost commented Apr 4, 2024

This PR contains 2 things (which should probably be separated), and is in draft because it's lacking a 3rd thing:

  1. A q-d implementation of the Circular Buffer example which is comes from the Pulse article and is also implemented in q-s-m. This example could be a good basis to explain and test parallel actions from First draft of parallel state machines #72
  2. An attempt at explaining what is Dynamic Logic and why it's important and useful
  3. A way to generate and publish these as documentation on this project's pages: https://input-output-hk.github.io/quickcheck-dynamic

Checklist:

  • Check source-code formatting is consistent

abailly added 13 commits March 29, 2024 09:48
Require shrinking the actions to ensure the example is minimal => Need
to shrink New for buffer size to decrease!
It's not possible to reproduce the second bug because `mod` operator
in Haskell is implementeed correctly, not like `rem` in C or Erlang.

> (-1) `mod` 2 == 1
The idea is that some of the documentation will be in Literate haskell
format and require some "building" to be generated.
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant