docs(manual): correct the stale "cannot be undone" claims for list actions - #127
Open
dustenhubbard wants to merge 1 commit into
Open
docs(manual): correct the stale "cannot be undone" claims for list actions#127dustenhubbard wants to merge 1 commit into
dustenhubbard wants to merge 1 commit into
Conversation
…tions Six sentences in `manual/readme.md` say an action cannot be undone when it can. `Edit Attributes` and `Edit Radius` on the object right-click menu both go through `Series.editObjectAttributes` and `Series.editObjectRadius`, which thread `series_states` into `Series.enumerateSections`. `SeriesIterator` records one series state up front and calls `addState` plus `addSectionUndo` for every section it modifies, so `Ctrl+Z` reverts the whole edit. The `Undo` and `Redo` entries claimed that nothing done through the object or section list can be undone. `MainWindow.undo` reads `series_states.canUndo()` and dispatches to `series_states.undoState()`, which covers exactly those actions, and it prompts "All sections" or "Only this section" when the action spanned several. Both entries appear twice, once under the menu bar and once under the field right-click menu, so that correction lands in four places. Leaves the `Delete` warning under the section right-click menu alone. `Series.deleteSections` calls `os.remove` on each section file and the slot then calls `field.clearStates()`, so "This action CANNOT be undone" is accurate there. The same holds for reordering sections and for optimizing brightness and contrast: those three are the only callers of `noUndoWarning`, and all three are correct. No source changes. Refs #121.
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.
Corrects six sentences in
manual/readme.mdthat say an action cannot be undone when it can. Documentation only.Edit AttributesandEdit Radiusboth passseries_statesthroughenumerateSections, which records undo state per modified section, soCtrl+Zreverts them. Neither path callsnoUndoWarning, so the application already does not warn there.The
UndoandRedoentries claim list actions are not covered at all, which contradicts the two above. Both entries appear twice, under the menu bar and under the field right-click menu, hence four of the six. The replacement also mentions the "All sections" or "Only this section" prompt.The
Deleteentry keeps its warning:deleteSectionsremoves files from disk and then clears the states, so it is accurate.Closes #121