Clarity improvement in magnifier naming#20281
Conversation
|
@CyrilleB79 I started rewritting the user docs and I'll do the same in the settings when #19913 is closed. |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR updates the magnifier “follow focus” terminology to “tracking” across the codebase, user docs, and scripts, and renames the fullscreen mode action from “toggle” to “cycle” for clarity.
Changes:
- Renamed
MagnifierFollowFocusTypetoMagnifierFollowTrackingTypeand updated related call sites. - Updated user documentation to reflect the new “tracking” terminology and revised descriptions.
- Renamed the fullscreen magnifier mode command from
toggleFullscreenModetocycleFullscreenMode.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| user_docs/en/userGuide.md | Renames “focus tracking” language to “tracking” and adjusts magnifier documentation/anchors. |
| tests/unit/test_magnifier/test_focusManager.py | Updates unit tests to use the renamed follow/tracking enum. |
| source/gui/settingsDialogs.py | Renames magnifier UI “Focus” group to “Tracking” and updates follow checkbox plumbing; also changes review cursor config key usage. |
| source/globalCommands.py | Updates scripts to use the renamed enum and cycles fullscreen mode via the renamed command. |
| source/_magnifier/utils/types.py | Renames the follow enum type and updates translation contexts/labels. |
| source/_magnifier/utils/focusManager.py | Migrates focus manager to the renamed tracking enum type. |
| source/_magnifier/config.py | Updates follow-state config mapping and public API parameter naming to “tracking”. |
| source/_magnifier/commands.py | Updates toggle-follow API to accept tracking type and renames fullscreen mode function to “cycle”. |
|
FYI, I have made modifications in #20261 which update UI strings and even more sometimes. These may conflict with this PR, sorry (especially regarding "follow mode" / "tracking type"). |
|
Also are we sure that "tracking mode" (previously "focus mode" / "full-screen mode") only applies to full-screen? Couldn't a docked mode user choose between "center" and "Border"? This PR is probably not the place to change that, but at least keep it in mind when/if changing variable/options names to avoid "full-screen" if the option may be moved in the future. And another question: |
Yes I will wait for your modification, I reverted to draft.
for now it's a fullscreen thing, because It's a fullscreen thing for Windows Magnifier, but nothing is fixed and this could be applied to other types of view, I think we could keep it as it is for know and change it if we want to add this to other modes, like spotlight (wich would be change to overview)
sometimes I feel like removing relatives would just save us some times, ahah |
Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>
| self.SYSTEM_FOCUS: pgettext("magnifier follow tracking type", "System focus"), | ||
| # Translators: Tracking type for magnifier to follow - review cursor position. | ||
| self.REVIEW: pgettext("magnifier follow tracking type", "Review cursor"), | ||
| # Translators: Tracking type for magnifier to follow - navigator object position. | ||
| self.NAVIGATOR_OBJECT: pgettext("magnifier follow tracking type", "Navigator object"), |
There was a problem hiding this comment.
| self.SYSTEM_FOCUS: pgettext("magnifier follow tracking type", "System focus"), | |
| # Translators: Tracking type for magnifier to follow - review cursor position. | |
| self.REVIEW: pgettext("magnifier follow tracking type", "Review cursor"), | |
| # Translators: Tracking type for magnifier to follow - navigator object position. | |
| self.NAVIGATOR_OBJECT: pgettext("magnifier follow tracking type", "Navigator object"), | |
| self.SYSTEM_FOCUS: pgettext("magnifier", "System focus"), | |
| # Translators: Tracking type for magnifier to follow - review cursor position. | |
| self.REVIEW: pgettext("magnifier", "Review cursor"), | |
| # Translators: Tracking type for magnifier to follow - navigator object position. | |
| self.NAVIGATOR_OBJECT: pgettext("magnifier", "Navigator object"), |
| self.panSpinCtrl.Bind(wx.EVT_TEXT, self._onImmediateSettingChange) | ||
|
|
||
| # Tracking GROUP | ||
| # TRACKING GROUP |
There was a problem hiding this comment.
The current case is preferred actually, there;s no need for all caps
| The actual pixel distance will automatically adjust based on your current zoom level. | ||
|
|
||
| Note: Pan commands allow you to manually move the magnified view in any direction, independent of the tracking mode. | ||
| Available pan actions include: |
There was a problem hiding this comment.
there's no pan actions below this. is this in the right place?
Link to issue number:
Closes #20126
Summary of the issue:
At the moment, the magnifier module lacks clarity in naming, it uses several terms to talk about the same things and that can lead to confusions
Description of user facing changes:
Users will have a better and clearer desciption and settings of the magnifier
Description of developer facing changes:
Variables and naming will be more consistent and logical
Description of development approach:
Adapting code naming to the User guide terms
Testing strategy:
Known issues with pull request:
Code Review Checklist: