Skip to content

Remove deprecated config options#18102

Merged
seanbudd merged 6 commits into
betafrom
removeDeprecatedConfig
May 19, 2025
Merged

Remove deprecated config options#18102
seanbudd merged 6 commits into
betafrom
removeDeprecatedConfig

Conversation

@SaschaCowley

Copy link
Copy Markdown
Member

Link to issue number:

Closes #18066

Summary of the issue:

Some deprecated config keys are still included in the config spec.

Description of user facing changes

None.

Description of developer facing changes

The config.conf["documentFormatting"]["reportFontAttributes"] definition has been removed from the config spec, and the code linking it and ["fontAttributeReporting"] has been removed.

Description of development approach

Removed the linking code and the line in the config spec.

Testing strategy:

Unit tests.

Known issues with pull request:

`config.conf["speech"]["includeCLDR"] would ideally also be removed, however the deprecation of this key was not documented, so I am unsure whether to remove it.

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@coderabbitai summary

@SaschaCowley SaschaCowley requested a review from a team as a code owner May 14, 2025 05:38
@SaschaCowley SaschaCowley requested a review from seanbudd May 14, 2025 05:38
@SaschaCowley SaschaCowley added this to the 2025.1 milestone May 14, 2025
@SaschaCowley SaschaCowley changed the base branch from master to beta May 14, 2025 05:40
@CyrilleB79

Copy link
Copy Markdown
Contributor

In any case, something should be done regarding config.conf["speech"]["includeCLDR"] . Either it should also be removed now or its deprecation period should be extended, until 2026.1 or until no specific date.

@LeonarddeR

Copy link
Copy Markdown
Collaborator

We can still deprecate it in 2025.1, can't we?

@SaschaCowley

Copy link
Copy Markdown
Member Author

We can still deprecate it, yes. @seanbudd what do you think? Should we remove config.conf["speech"]["includeCLDR"] this late in the beta cycle, or just document that it is deprecated for removal in 2026.1? If the latter, I need to slightly tweak the linking code

@seanbudd

Copy link
Copy Markdown
Member

@SaschaCowley - I think we need to remove it, as _linkDeprecatedValues is no longer being hit, support has been defacto removed.

@SaschaCowley SaschaCowley marked this pull request as draft May 19, 2025 00:32
@SaschaCowley SaschaCowley marked this pull request as ready for review May 19, 2025 00:56
Comment thread user_docs/en/changes.md Outdated
@seanbudd seanbudd merged commit 4a9a2bf into beta May 19, 2025
5 checks passed
@seanbudd seanbudd deleted the removeDeprecatedConfig branch May 19, 2025 03:36
Comment thread source/globalCommands.py
seanbudd pushed a commit that referenced this pull request May 19, 2025
Follow-up to #18102

Summary of the issue:
When fixing the `GlobalCommands.script_reportCLDR" method, I forgot that you can't just mutate lists in the config, or configobj doesn't know they've changed, so the changes will not be persisted to disc.

Description of user facing changes
The toggle CLDR script will now be persisted across sessions.

Description of development approach
Make a copy of config.conf["speech"]["symbolDictionaries"], mutate it, then save it back.
Initially tried just mutating it and then setting it to itself, but this did not work. Presumably there is some check for identity somewhere, and since all empty lists are identicle, __setitem__ was not called.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Possibility to get removed config items

4 participants