Skip to content

Remove unused 'upgrade' config profile section#17191

Merged
seanbudd merged 4 commits into
masterfrom
remUpgradeConfig
Sep 19, 2024
Merged

Remove unused 'upgrade' config profile section#17191
seanbudd merged 4 commits into
masterfrom
remUpgradeConfig

Conversation

@seanbudd

@seanbudd seanbudd commented Sep 19, 2024 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Link to issue number:

None

Summary of the issue:

The only setting newLaptopKeyboardLayout for the config section upgrade is unused in NVDA

Description of user facing changes

None

Description of development approach

Remove this unused setting

Summary by CodeRabbit

  • New Features

    • Simplified configuration options by removing the "upgrade" section from the configuration management settings.

  • Bug Fixes

    • Eliminated the newLaptopKeyboardLayout setting to streamline configuration management and reduce complexity.

@seanbudd seanbudd requested a review from a team as a code owner September 19, 2024 01:01
@coderabbitai

coderabbitai Bot commented Sep 19, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

The pull request introduces changes to the configuration management system by removing specific entries from configuration sets in two files. The BASE_ONLY_SECTIONS set in the ConfigManager class no longer includes the "upgrade" section, and the configuration option for newLaptopKeyboardLayout has been eliminated from the configuration specification. These modifications streamline the configuration options available within the application.

Changes

File Change Summary
source/config/__init__.py Removed "upgrade" from the BASE_ONLY_SECTIONS set in the ConfigManager class.
source/config/configSpec.py Removed the [upgrade] section, including newLaptopKeyboardLayout = boolean(default=false).

Possibly related PRs

Suggested labels

conceptApproved

Suggested reviewers

  • leonardder

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai generate interesting stats about this repository and render them as a table.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

SaschaCowley
SaschaCowley requested changes Sep 19, 2024
View reviewed changes

@SaschaCowley SaschaCowley left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much as we don't use this, and I seriously doubt any add-on authors use it either, the config spec is part of the public API, so I think we need a note in the Changes for Developers. In particular, if authors are expecting the upgrade section to be there, they'll get an error when attempting to write to it.

@SaschaCowley SaschaCowley added this to the 2025.1 milestone Sep 19, 2024
SaschaCowley
SaschaCowley approved these changes Sep 19, 2024
View reviewed changes
Comment thread user_docs/en/changes.md Outdated
@AppVeyorBot

AppVeyorBot commented Sep 19, 2024

Copy link
Copy Markdown

See test results for failed build of commit b614a7ea48

@seanbudd seanbudd merged commit 72b0006 into master Sep 19, 2024
@seanbudd seanbudd deleted the remUpgradeConfig branch September 19, 2024 05:56
@nishimotz nishimotz mentioned this pull request Apr 14, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SaschaCowley SaschaCowley SaschaCowley approved these changes

Assignees

No one assigned

Labels

api-breaking-change

Projects

None yet

Milestone

2025.1

Development

Successfully merging this pull request may close these issues.

3 participants

@seanbudd @AppVeyorBot @SaschaCowley