Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

implement deprecation of SAYALL behaviour for speakTextInfo #12150

Merged
merged 4 commits into from Mar 12, 2021
Merged

Conversation

seanbudd
Copy link
Member

@seanbudd seanbudd commented Mar 11, 2021

Link to issue number:

Part of #12123

Implements deprecation announced in: #10878

Summary of the issue:

sayAllHandler was changed to use speakWithoutPauses as a default. Developers wanting to use the original behaviour of
speech.speakTextInfo with reason as SAYALL should use sayAllHandler

Description of how this pull request fixes the issue:

speakTextInfo will no longer send speech through speakWithoutPauses if reason is SAYAll, as sayAllhandler does this manually now.

Testing strategy:

Search the code base for usages of SAYALL and confirm the only ones that are being set are within sayAllHandler, which handles this behaviour and doesn't trigger deprecation warnings.

find . -type f -name '*.py' -exec grep -P "\bSAYALL\b" {} +

Manual testing of "say all" behaviour - such as reading all the text or controls of a document may help confirm this and would trigger the deprecations warnings now if this wasn't handled correctly.

Known issues with pull request:

None

Change log entry:

Developer Changes

- `speakTextInfo` will no longer send speech through `speakWithoutPauses` if reason is `SAYALL`, as `sayAllhandler` does this manually now. (#12150)

Code Review Checklist:

  • Pull Request description is up to date.
  • Unit tests.
  • System (end to end) tests.
  • Manual tests.
  • User Documentation.
  • Change log entry.
  • Context sensitive help for GUI changes.

@seanbudd seanbudd changed the title implement deprecation of SAYALL behaviour for speakTextInfo in favour… implement deprecation of SAYALL behaviour for speakTextInfo Mar 11, 2021
@seanbudd seanbudd mentioned this pull request Mar 11, 2021
18 tasks
@seanbudd seanbudd requested review from michaelDCurran and feerrenrut and removed request for michaelDCurran March 11, 2021 03:08
@seanbudd seanbudd self-assigned this Mar 11, 2021
@seanbudd seanbudd added the deprecated/2021.1 Label used to track deprecations due for removal in the 2021.1 release label Mar 11, 2021
@seanbudd seanbudd added this to the 2021.1 milestone Mar 11, 2021
Copy link
Contributor

@feerrenrut feerrenrut left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks @seanbudd

@seanbudd seanbudd merged commit 52bf1ed into master Mar 12, 2021
@seanbudd seanbudd deleted the dep-10878 branch March 12, 2021 00:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated/2021.1 Label used to track deprecations due for removal in the 2021.1 release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants