Skip to content

docs: add detailed section on sync module and its integration with loom#13

Merged
soltanoff merged 1 commit into
masterfrom
feat/docs-about-sync
Mar 7, 2026
Merged

docs: add detailed section on sync module and its integration with loom#13
soltanoff merged 1 commit into
masterfrom
feat/docs-about-sync

Conversation

@soltanoff

Copy link
Copy Markdown
Owner

This pull request adds documentation to clarify the purpose and usage of concurrency testing tools and the custom sync module in the project. The most important changes include new explanations and links for loom and Miri in the main README.md, and a detailed guide for the sync module in its own README.

Concurrency testing tools documentation:

  • Added a brief description and link to the loom library in README.md, explaining its role in testing parallel and concurrent programs.
  • Added a brief description and link to the Miri interpreter in README.md, outlining its ability to detect undefined behavior in Rust code.

sync module documentation:

  • Created a new src/sync/README.md file explaining the motivation, design, and usage of the sync abstraction layer for compatibility with loom, including how it enables deterministic concurrency testing and how to use it in the project.

@soltanoff soltanoff self-assigned this Mar 7, 2026
@soltanoff soltanoff added the documentation Improvements or additions to documentation label Mar 7, 2026
@soltanoff soltanoff force-pushed the feat/docs-about-sync branch from daa113c to 68a169e Compare March 7, 2026 17:47
@soltanoff soltanoff merged commit 157602e into master Mar 7, 2026
6 checks passed
@soltanoff soltanoff deleted the feat/docs-about-sync branch March 7, 2026 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant