Repository navigation
An archive is not publishable prose - #305
Merged
Merged
Conversation
Archiving a retired document changes its path and nothing else. Its text is the text it always had, written when those tokens were current. PROTEA moved eight retired documents into docs/archive last night and the reranker-token linter failed the change over 21 v1 and v3 tokens, none of which had ever been publishable prose. The only remedy available was to rewrite the retired documents, which destroys the thing that makes them provenance. SKIP_DIRS prunes by directory name during the walk, so one entry covers all three callers: docs/archive in PROTEA, plans/archive here, notes/archive in the thesis. Each of them keeps that directory precisely so a reader can tell what is current from what is not, and the linter now reads the same boundary. Three tests, and the second is the counterweight: the same token outside an archive still offends, so pruning the directory has not blunted the linter.
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.
Archiving a retired document changes its path and nothing else. Its text is the text it always had, written when those tokens were current.
PROTEA moved eight retired documents into
docs/archivelast night and this linter failed the change over 21v1andv3tokens, none of which had ever been publishable prose. The only remedy available then was to rewrite the retired documents — which destroys the thing that makes them provenance.SKIP_DIRSprunes by directory name during the walk, so one entry covers all three callers:docs/archivein PROTEA,plans/archivehere,notes/archivein the thesis. Each of them keeps that directory precisely so a reader can tell what is current from what is not, and the linter now reads the same boundary the repositories already draw.Three tests. The second is the counterweight: the same token outside an archive still offends, so pruning the directory has not blunted the linter. The third checks it is pruned at any nesting depth, because the three callers nest it differently.