docs: align README with 0.6.0 NIF/stream changes#144
Draft
ausimian wants to merge 1 commit into
Draft
Conversation
- Building: describe pinned native_checksums.txt + :erl_tar extraction instead of the removed .sha256 sidecar mechanism - Concurrency: document Emily.Stream.close/1, off-scheduler reaper teardown, the bounded worker queue, and the new worker_queue_limit / await_timeout config keys - mix.exs: fix the stale sidecar comment on @supported_targets https://claude.ai/code/session_01MXUtxvRvvrhsXydhnFZbUM
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
2 participants
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.
Summary
The README still described pre-0.6.0 behaviour in a few places. This brings it in line with the 0.6.0 native (NIF) / stream changes.
native_checksums.txt(shipped inside the hex package, trust root covered bymix.lock) and:erl_tarstrict-allowlist extraction, replacing the removed.sha256sidecar mechanism.Emily.Stream.close/1for deterministic teardown, and correct the teardown description — the OS thread is now joined off the BEAM schedulers by a dedicated reaper, not inline in the NIF destructor.{:error, :stopped}reply on stopped/dropped workers, and the newworker_queue_limit/await_timeoutconfig keys.@supported_targetsto match the pinned-checksum mechanism.Docs-only (plus one comment in
mix.exs); no code behaviour change.https://claude.ai/code/session_01MXUtxvRvvrhsXydhnFZbUM
Generated by Claude Code