Fixes ExDoc reference warnings - #33
Merged
Merged
Conversation
mix docs warned on every doc reference to a hidden module or an unqualified callback: - Qualifies the c:init/1, c:encryption_key/2 and c:decryption_keys/2 references in Provider.Conformance as c:Encryptor.Provider.* - ExDoc resolves a short c: reference only inside the module that defines the callback. - Rephrases prose references to the hidden internal path modules (Vault.Encrypt, Vault.Decrypt, Vault.Rekey, Vault.Derive, Vault.Keyring) to name the source file instead. The modules stay hidden: they are internal pipeline modules, and unhiding them would widen the documented surface, which is an ADR decision, not a warnings fix. The recorded rationale in each sentence is kept. - Rephrases the reference to the engine's hidden compute_encryption_cache_id/3 the same way. The remaining docs warnings (README ADR file links) are fixed by PR #32.
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.
Fixes every
mix docsreference warning inlib/ahead of the 0.2.0 docs build.c:init/1,c:encryption_key/2andc:decryption_keys/2references inEncryptor.Provider.Conformanceasc:Encryptor.Provider.*- ExDoc only resolves a shortc:reference inside the module that defines the callback.Vault.Encrypt,Vault.Decrypt,Vault.Rekey,Vault.Derive,Vault.Keyring) to name the source file instead. The modules stay hidden: unhiding them would widen the documented surface, which is an ADR decision rather than a warnings fix. Every sentence carrying recorded rationale is kept, reworded rather than deleted.compute_encryption_cache_id/3reference inVault.Partition.With #32 (README ADR links) also applied,
mix docscompletes with zero warnings - verified locally with both changes combined. Fullmix qualitygreen: 419/419 tests, 98.2% coverage.If the operator would rather unhide some of the
Vault.*path modules and give them real moduledocs, that supersedes the rephrasings here and should be decided as its own change.