Docs: state which unknown-word choices are remembered - #13338
Merged
Conversation
"Skip all" lasts only for the current session; Change all, Add to names list and Add to user dictionary are written to disk. Neither the OCR nor the spell-check page said so, which is what made persisting the skip list look like a bug fix rather than a behaviour change (#10166, PR #13284). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Merged
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.
Problem
Neither the OCR page nor the spell-check page said which of the unknown-word choices are remembered and which are not. Both list "Change all" and "Skip all" side by side with no hint that one is written to disk and the other disappears when the window closes.
That gap is what made #13284 ("Skip all choices are now remembered") look like a bug fix rather than a behaviour change: #10166 reads as a defect precisely because the documented behaviour never existed to contradict it.
Change
Documentation only — no code.
docs/features/ocr.md— a "What is remembered" table under Unknown Words:{language}_OCRFixReplaceList.xml{language}_names.xml{language}_user.xml…plus a short paragraph on why "Skip all" is deliberately temporary (a mis-click should not have lasting consequences) and which choice to use instead when you do want something permanent.
docs/features/spell-check.md— the same distinction inline in the existing option list, with a shorter note.Verified
Change all→OcrFixEngine.ChangeAll→OcrFixReplaceList2.AddWordOrPartial→SaveWordToWordList, which writes<lang>_OCRFixReplaceList.xml. Persisted.Skip all→OcrFixEngine.SkipAlladds to the in-memory_wordSkipListonly; it is created per engine instance and cleared byUnload(). Nothing reads or writes disk. Session-only.ShowHelp("features/ocr")(OcrViewModel.cs:4521) and the spell-check window callsShowHelp("features/spell-check")(SpellCheckViewModel.cs:931).ShowHelp(...)targets insrc/uiagainstdocs/<target>.md— every one resolves, none missing.Related
Tools.CheckOneLetterWordssetting that 4.0.14 had (OcrFixEngine:correct = !Configuration.Settings.Tools.CheckOneLetterWords, defaulted totrueinToolsSettings.cs:541). It does not exist anywhere insrctoday, and there is no single-character branch insrc/libuilogic/Ocr/FixEngine/OcrFixEngine.cs— so the supported way to stop single-letter prompts is gone. That is the likelier root fix for the reporter and is worth its own issue.