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

Add documentation for the STM module #145

Merged
merged 1 commit into from
Oct 5, 2022
Merged

Add documentation for the STM module #145

merged 1 commit into from
Oct 5, 2022

Conversation

jmid
Copy link
Collaborator

@jmid jmid commented Sep 30, 2022

This PR documents the STM module in a corresponding STM.mli file.

The majority of the documentation is simply moved from STM.ml.

@jmid
Copy link
Collaborator Author

jmid commented Oct 5, 2022

I'll merge as this initial STM documentation is a reasonable starting point which we can improve in later PRs...

@jmid jmid merged commit 9c8e26a into main Oct 5, 2022
@jmid jmid deleted the stm-documentation branch October 5, 2022 12:50
@jmid jmid mentioned this pull request Oct 11, 2022
@n-osborne n-osborne mentioned this pull request Nov 2, 2022
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.

1 participant