Follow-up of #16359 - Make incompatibility messages more explicit by CyrilleB79 · Pull Request #16839 · nvaccess/nvda

CyrilleB79 · 2024-07-08T22:42:28Z

Link to issue number:

Follow-up of #16359

Summary of the issue:

In #16359, an add-on incompatibility message has been made more explicit. Two other similar message need to be made clearer too.

Description of user facing changes

Modify the original message adding a missing "NVDA" word
Rephrased the two other similar incompatibility messages the same way.

Description of development approach

N/A

Testing strategy:

Checked the 3 messages in add-on store:

in other details field for an incompatible add-on
when installing an incompatible add-on
when enabling an incompatible add-on

Known issues with pull request:

None

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.

Summary by CodeRabbit

Improvements
- Enhanced clarity of messages regarding add-on compatibility with NVDA versions.
- Updated messages now specify both the last tested NVDA version and the required NVDA version for installation and enabling of add-ons.

…icit

AppVeyorBot · 2024-07-08T23:43:32Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
PASS: System tests (tags: installer NVDA).
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/4odem4mnh19y2g8p/artifacts/output/nvda_snapshot_pr16839-32840,c23c6f9d.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 1.1,
INSTALL_END 1.1,
BUILD_START 0.0,
BUILD_END 12.3,
TESTSETUP_START 0.0,
TESTSETUP_END 0.4,
TEST_START 0.0,
TEST_END 18.4,
FINISH_END 1.4

See test results for failed build of commit c23c6f9d34

coderabbitai · 2024-07-10T14:39:53Z

Walkthrough

The recent updates enhance the clarity of messages related to add-on compatibility with NVDA versions. Specifically, these changes ensure that users are informed about the last tested NVDA version and the required NVDA version for the add-on installation or enabling process. There are no changes to the declarations of exported or public entities within the modified files.

Changes

File Path	Change Summary
`source/addonStore/models/version.py`	Updated a method message to clarify NVDA version compatibility.
`source/gui/addonStoreGui/controls/...`	Modified `_shouldInstallWhenAddonTooOldDialog` and `_shouldEnableWhenAddonTooOldDialog` methods to include last tested and required NVDA versions. Updated message template variable from `{NVDAVersion}` to `{nvdaVersion}`.

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6d67aa6 and fe4f1f1.

Files selected for processing (2)

source/addonStore/models/version.py (1 hunks)
source/gui/addonStoreGui/controls/messageDialogs.py (2 hunks)

Files skipped from review due to trivial changes (1)

source/addonStore/models/version.py

Additional context used

Path-based instructions (1)

source/gui/addonStoreGui/controls/messageDialogs.py (2)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious.

Pattern **/*.py: _, pgettext, ngettext, and ngettext are defined globally, errors for this being undefined can be ignored.

Additional comments not posted (2)

source/gui/addonStoreGui/controls/messageDialogs.py (2)

160-161: Improved message clarity for add-on installation.

The changes improve the message clarity by specifying the last tested NVDA version and the required NVDA version. This helps users understand the compatibility issues better.

Also applies to: 168-168

193-194: Improved message clarity for add-on enabling.

The changes improve the message clarity by specifying the last tested NVDA version and the required NVDA version. This helps users understand the compatibility issues better.

Also applies to: 201-201

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>.
- 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 show all the console.log statements in this repository.
- @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

SaschaCowley

I think these messages could be tightened up a little, but overall they're great!

SaschaCowley · 2024-07-11T00:25:45Z

-		"your current NVDA version is {NVDAVersion}. "
+		"This add-on was last tested with NVDA {lastTestedNVDAVersion}. "
+		"NVDA requires this add-on to be tested with NVDA {nvdaVersion} or higher. "
 		"Installation may cause unstable behavior in NVDA.\n"


Suggested change

"Installation may cause unstable behavior in NVDA.\n"

"Installing this add-on may cause NVDA to become unstable.\n"

I think this is slightly clearer.

SaschaCowley · 2024-07-11T00:29:13Z

-		"your current NVDA version is {NVDAVersion}. "
+		"This add-on was last tested with NVDA {lastTestedNVDAVersion}. "
+		"NVDA requires this add-on to be tested with NVDA {nvdaVersion} or higher. "
 		"Enabling may cause unstable behavior in NVDA.\n"


Suggested change

"Enabling may cause unstable behavior in NVDA.\n"

"Enabling this add-on may cause NVDA to become unstable.\n"

Ditto.

SaschaCowley · 2024-07-11T00:32:55Z

I'm not hugely fond of "Proceed with (installation|enabling) anyway? ", but don't have anything better to suggest, other than "(Install|Enable) anyway?", which may come across as a little terse.

SaschaCowley · 2024-07-11T00:35:04Z

-				"This add-on was last tested with {lastTestedNVDAVersion}. "
+				"This add-on was last tested with NVDA {lastTestedNVDAVersion}. "
 				"NVDA requires this add-on to be tested with NVDA {nvdaVersion} or higher. "
 				"You can enable this add-on at your own risk. "


Maybe consider replacing this with the note on instability as in the enable dialog?

seanbudd

While I agree with @SaschaCowley's suggestions, I think they are best applied in a separate PR to master, as this is trying to make the beta messaging more consistent with other changes in the beta

Follow-up of nvaccess#16359 - Make incompatibility messages more expl…

07cc58e

…icit

Adriani90 mentioned this pull request Jul 9, 2024

https://github.com/CyrilleB79/nvda/pull/new/incompaMsgFollow-up of #16359 - Make incompatibility messages more explicit #16838

Closed

5 tasks

Fix min API version number

fe4f1f1

CyrilleB79 marked this pull request as ready for review July 10, 2024 14:39

CyrilleB79 requested a review from a team as a code owner July 10, 2024 14:39

CyrilleB79 requested review from SaschaCowley and removed request for a team July 10, 2024 14:39

SaschaCowley requested changes Jul 11, 2024

View reviewed changes

seanbudd approved these changes Jul 11, 2024

View reviewed changes

seanbudd added this to the 2024.3 milestone Jul 11, 2024

seanbudd merged commit 3f0084e into nvaccess:beta Jul 11, 2024

CyrilleB79 deleted the incompaMsg branch July 16, 2024 11:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Follow-up of #16359 - Make incompatibility messages more explicit#16839

Follow-up of #16359 - Make incompatibility messages more explicit#16839
seanbudd merged 2 commits into
nvaccess:betafrom
CyrilleB79:incompaMsg

CyrilleB79 commented Jul 8, 2024 •

edited by coderabbitai Bot

Loading

Uh oh!

AppVeyorBot commented Jul 8, 2024

Uh oh!

coderabbitai Bot commented Jul 10, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

SaschaCowley left a comment

Uh oh!

SaschaCowley Jul 11, 2024

Uh oh!

SaschaCowley Jul 11, 2024

Uh oh!

SaschaCowley Jul 11, 2024

Uh oh!

SaschaCowley Jul 11, 2024

Uh oh!

seanbudd left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	"Installation may cause unstable behavior in NVDA.\n"
	"Installing this add-on may cause NVDA to become unstable.\n"

	"Enabling may cause unstable behavior in NVDA.\n"
	"Enabling this add-on may cause NVDA to become unstable.\n"

Uh oh!

Conversation

CyrilleB79 commented Jul 8, 2024 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Summary by CodeRabbit

Uh oh!

AppVeyorBot commented Jul 8, 2024

Uh oh!

coderabbitai Bot commented Jul 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

SaschaCowley left a comment

Choose a reason for hiding this comment

Uh oh!

SaschaCowley Jul 11, 2024

Choose a reason for hiding this comment

Uh oh!

SaschaCowley Jul 11, 2024

Choose a reason for hiding this comment

Uh oh!

SaschaCowley Jul 11, 2024

Choose a reason for hiding this comment

Uh oh!

SaschaCowley Jul 11, 2024

Choose a reason for hiding this comment

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CyrilleB79 commented Jul 8, 2024 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 10, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)