Remove experimental flag from 2024.4 API

[SaschaCowley]

Should be merged after 2024.4rc1 has successfully been built.

Summary by CodeRabbit

• New Features
  • Updated NVDA versioning information, marking version 2024.4 as stable and removing its experimental status.
  • Maintained the experimental status for NVDA version 2025.1, indicating ongoing testing.

[coderabbitai]

Walkthrough

The changes involve updates to the nvdaAPIVersions.json file, specifically modifying the experimental status of NVDA releases. The "experimental": true field has been removed from the entry for NVDA version 2024.4, indicating it is no longer experimental. Conversely, the entry for NVDA version 2025.1 retains the experimental designation. The overall structure of the JSON file remains unchanged, maintaining fields for description, API version, backward compatibility, and the experimental status.

Changes

File	Change Summary
nvdaAPIVersions.json	Removed "experimental": true from NVDA version 2024.4; added "experimental": true to NVDA version 2025.1.

Poem

In the garden where versions play,
A change has come to light today.
One version now stands tall and bright,
While another still dances in the night.
With JSON fields both clear and neat,
The future of NVDA looks sweet! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 794090b and e4d7684.

📒 Files selected for processing (1)

• nvdaAPIVersions.json (1 hunks)

🧰 Additional context used

🔇 Additional comments (4)

nvdaAPIVersions.json (4)

Line range hint 529-534: LGTM: Experimental flag removed from NVDA 2024.4

The experimental flag has been successfully removed from the NVDA 2024.4 entry, which aligns with the PR objective of removing the experimental flag from the 2024.4 API.

---

Line range hint 535-544: LGTM: Experimental flag added to NVDA 2025.1

The experimental flag has been correctly added to the NVDA 2025.1 entry, maintaining the expected structure for future experimental versions.

---

Line range hint 1-544: Summary: Changes align with PR objectives

The modifications to nvdaAPIVersions.json successfully achieve the PR objective of removing the experimental flag from the 2024.4 API. The changes include:

1. Removal of the experimental flag from NVDA 2024.4.
2. Addition of the experimental flag to NVDA 2025.1, maintaining the structure for future experimental versions.

The overall consistency and structure of the JSON file have been maintained. However, please ensure that the backward compatibility of NVDA 2024.4 with versions 2024.1 through 2024.3.1 is verified, as flagged in the previous comment.

These changes appear ready to be merged after the successful build of version 2024.4rc1, as specified in the PR description.

---

Line range hint 529-534: Verify backward compatibility of NVDA 2024.4

The backCompatTo field for NVDA 2024.4 indicates compatibility with 2024.1. Please confirm that this is intentional and that no changes in 2024.4 break compatibility with versions between 2024.1 and 2024.3.1.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.