Fixes owner-noun wording after the Scope rename - #118
Merged
Merged
Conversation
provision/3's doc said scope_ref/2's signature was amended at acceptance; the function was tenant_ref/2 then, and the sentence now says so. The bench context rows named a :tenant vault, a profile that is :scoped now; the rows and their comment say scoped, and the "tenant_ref" wire key stays as spelled. derive's docs used "scope" for the :info string and for the key's owner. The derive doc now says a scope is always the owner, calls :info a separation string, and notes that ADR-0003 amendment A's word for :info is "scope" in the derivation's sense. The Kdf doctests' prose and the Derive comments drop the derivation sense and the "goes out of scope" idiom. Refs: enc-gf3j Refs: enc-bw8
johnnyt
force-pushed
the
enc-gf3j-scope-rename-wording
branch
from
September 30, 2026 05:51
f6c39c0 to
c189f6c
Compare
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.
Two wording fixes left after the Scope rename (ADR-0009), in one PR. Wording only: no code, no public name and no wire spelling changes.
enc-gf3j: two stale owner-noun mentions
Encryptor.Envelope.provision/3's doc saidscope_ref/2's signature was amended at acceptance. At acceptance the function wastenant_ref/2(ADR-0003's Status line says so); the sentence now names the reference function and says it wastenant_ref/2then and ADR-0009 renamed itscope_ref/2.bench/bounds.exs's context-cost comment named a:tenantvault, a profile that is:scopedsince ADR-0009. The comment and its two row labels now say scoped; the"tenant_ref"context key stays as spelled and the comment names it as the pinned v1 wire key.enc-bw8: "scope" in derive's docs
derive/3's docs used "scope" both for the key's owner and for the derivation inputs. The derive doc now says that in its text a scope is always the key's owner and names the derivation inputs separately, calls:infoa separation string whose empty value is legitimate, and notes that ADR-0003 amendment A's word for:infois "scope" in the derivation's sense. TheEncryptor.Kdf.salted_subkey/5doctest prose and theEncryptor.Vault.Derivecomments drop the derivation sense and the "goes out of scope" idiom. Sentences where scope already meant the owner (a per-scope vault, a scope's index key and master key) are unchanged.Review (in-turn)
Re-read the diff against both beads' acceptance. Checked by anchor on this branch: ADR-0003's Status line names the
tenant_ref/2signature amendment; ADR-0009's Context names the former:tenantcontext profile and thetenant_ref/2function;Encryptor.Vault.Configaccepts:singleand:scopedprofiles; ADR-0003 amendment A decision 4 says an emptyinfois a legitimate scope;Encryptor.Vault.Derive.call/3passes purpose, info and length toEncryptor.Kdf.salted_subkey/5. No persisted or serialized string moved: the"tenant_ref"key, the"encryptor/v1/tenant-ref"label and the"tenant-ref"purpose appear unchanged. No test asserts the changed prose, and no bench output is read elsewhere in the repo.Provenance
changelog.d/README.md.Gate
mix qualitygreen on the committed tree rebased onto main (all stages, Docs and Doc links included; 671 of 671 tests).Refs: enc-gf3j, enc-bw8