docs: bump README install hint to 0.7 and clarify deferred :allow contract#79
Merged
Conversation
…tract - README installation snippets pointed at `~> 0.6`; the current line is 0.7 (0.7.1 just released). - DuplexSession.respond_to_permission/3 doc said the decision shape is identical to a synchronous handler return value. After #71/#76 that is subtly inaccurate: the sync dispatch defaults `:allow` to `{:allow, input}` automatically, but the deferred path can't (the session does not retain per-request input across the defer boundary). Add an admonition spelling out that callers using the deferred path should pass `{:allow, input}` if they need `updatedInput` populated.
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
1 participant
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
~> 0.6; the current line is 0.7 (0.7.1 just released).DuplexSession.respond_to_permission/3docstring said the decision shape was identical to a synchronous handler return value. After DuplexSession :allow should default updatedInput to original input #71/fix: DuplexSession :allow defaults updatedInput to original input #76 that is subtly inaccurate: the sync dispatch defaults:allowto{:allow, input}automatically, but the deferred path can't (the session does not retain per-request input across the defer boundary). The new admonition spells out that callers using the deferred path should pass{:allow, input}if they needupdatedInputpopulated.Test plan
mix format --check-formattedmix compile --warnings-as-errorsmix docs(no warnings)mix credo --strictmix test(136 tests, 0 failures)