Repository navigation
fix(config): say the metadata axes govern what is written next, not that they rewrite - #4
Merged
Conversation
…hat they rewrite The consequence on `metadata.format` and `metadata.embed` claimed a rewrite of every document, which nothing on Apply performs. Both now state prov's rule: the setting applies to metadata written from now on, a new document takes its parent's carrier, and existing documents keep theirs until `prov convert <root> metadata.<axis> <value> -r`. A test holds the row's description and the consequence Apply reads to that sentence. Closes docs/tasks/metadata-axes-claim-a-rewrite.md. Behavioural-change: the description and on-change consequence message for metadata.format and metadata.embed in config_schema are new sentences; tint and severity are unchanged.
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.
What changed
config_schema.rsshowed this sentence onmetadata.formatandmetadata.embed, both on the row and as theConfirmconsequence a frontend reads before Apply:Both now say what applying the change actually does. For example,
metadata.format:metadata.embedgets the same sentence, saying "shape" andmetadata.embed. The doc comment onrules::costlyno longer says every costly axis rewrites the workspace.Why
Nothing on Apply rewrites anything. prov's rule for a config axis (
prov/docs/config-vocab.md, "Restating existing documents") is that the setting governs what is written next, andprov convert … -ris a separate, deliberate step. A warning that overstates is one people learn to click through. This takes option 1 of the task, "Say what happens".Tint (
Warning) and severity (Confirm) are left as they were. The task suggested aNoticemight be the more honest weight, and that call is left to a maintainer.Closes
docs/tasks/metadata-axes-claim-a-rewrite.md(markedstatus: donein this branch, with a status note).The task also asks for the reference axes to be checked against the same rule.
references.notation,references.path_styleandreferences.target(and theirrelations.*overrides) still say "Rewrites every link in the workspace.", and that is just as untrue. This PR leaves them alone:targethas noprov convertaxis, andwikilinkis offered fornotationbut isn't one ofprov convert's documented values, so their sentences need a decision first.Verification
a_metadata_axis_says_it_governs_what_is_written_next. It failed before the fix and passes after. For both axes it checks that the sentence makes no rewrite claim, says existing documents keep their spelling, names the exactprov convertcommand, and matches the consequence Apply reads.ship ci: all 6 jobs pass (fmt, clippy-D warnings, test, docs, package-isolation, MSRV).prov checkgives the same 2 findings as onmain: retired view keys inconfig/prov.yaml. This change doesn't touch them.