Remove a demo script #15904
Merged
Remove a demo script #15904
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can you please add a change log entry as this is an API breaking change. I think this is sufficient documentation of the change. |
seanbudd
approved these changes
Dec 11, 2023
Yes, makes sense. Change log added in ea4c142. I have used the PR's number rather than the one of the issue. Unless the issue describes a code design change (e.g. speech refactor), I prefer put the issue number in the firsts paragraphs of the change log, but the PR number in the paragraph "Changes for developers" and its sub-paragraph. |
Adriani90
pushed a commit
to Adriani90/nvda
that referenced
this pull request
Mar 13, 2024
Link to issue number: Closes nvaccess#11465 Summary of the issue: NVDAObjects\IAccessible\winword.py contains a script that is not documented (no input help, not mentioned in user Guide). It has been introduced in commit 465dce8 when nvaccess#3110 has been implemented as a demo script to test the new headers reading capability. This script cause an error in the log when called outside of a table. Description of user facing changes No more error when pressing NVDA+shift+H in Word document. Description of development approach Just removed the script.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@seanbudd, feel free to merge or to close without merging, depending on your answer to #11465 (comment).
Link to issue number:
Closes #11465
Summary of the issue:
NVDAObjects\IAccessible\winword.pycontains a script that is not documented (no input help, not mentioned in user Guide). It has been introduced in commit 465dce8 when #3110 has been implemented as a demo script to test the new headers reading capability.This script cause an error in the log when called outside of a table.
Description of user facing changes
No more error when pressing
NVDA+shift+Hin Word document.Description of development approach
Just removed the script.
Testing strategy:
Tested that NVDA+shift+H does not produce any error in Word document.
Known issues with pull request:
This script is probably used by nobody since it is undocumented: it does not appear in input help, nor in input gesture dialog, nor in User Guide. Anyway, we cannot exclude 100% that someone uses this undocumented and unadvertised feature.
If it is the case, let's hope that this person will make a feedback to explain their need.
Code Review Checklist:
For information
Cc @michaelDCurran, in case you have something to say since you were the one who had introduced this script.