Repository navigation
Split the README, and a style pass over the docs - #24
Merged
Merged
Conversation
The README was near 1200 lines, a fifth of it the optional headers. Each now has its own page, and the README keeps a short summary of each with a link. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SR7v9BVsFrHiEhQBSqZmAs
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SR7v9BVsFrHiEhQBSqZmAs
Split long sentences, drop setup colons, dashes, and selling words, and use the serial comma throughout. Also fix a few things that were out of date or wrong, such as the PT_DONE return value note, the claim that an interrupt handler must set its flag before signaling, and pthread "event variables". Add a per-core protothread_t arrangement to the multi-core section, and a TODO for pt_broadcast_all(). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SR7v9BVsFrHiEhQBSqZmAs
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SR7v9BVsFrHiEhQBSqZmAs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README had grown long, so the semaphore, timer, lock, and queue sections move to their own pages under
doc/. The README keeps a short summary of each, with a link.The rest is a pass over the README and the doc pages for readability: shorter sentences, fewer dashes and semicolons, no meta comments or selling words, and the serial comma throughout. A few things that were out of date or wrong are fixed along the way, for example the note about what a protothread function's return value is used for, which predated
pt_join().There's one new paragraph in the multi-core section, about running one
protothread_tper OS thread. TODO.md gets a note about apt_broadcast_all()to come in a separate PR.The only code change is a rename in
protothread_test.c(after_thrtotimeout_thr) so the test matches the example indoc/queue.md.🤖 Generated with Claude Code
https://claude.ai/code/session_01SR7v9BVsFrHiEhQBSqZmAs