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

GitHub Issue Report: PSReadLine Compatibility Warning #3780

Closed
3 tasks done
ryanisaac26 opened this issue Aug 17, 2023 · 0 comments
Closed
3 tasks done

GitHub Issue Report: PSReadLine Compatibility Warning #3780

ryanisaac26 opened this issue Aug 17, 2023 · 0 comments

Comments

@ryanisaac26
Copy link

Prerequisites

  • Write a descriptive title.
  • Make sure you are able to repro it on the latest released version
  • Search the existing issues, especially the pinned issues.

Exception report

Exception Overview:
While the compatibility warning regarding PSReadLine and screen reader usage has been identified, it's important to acknowledge that the warning might be necessary for ensuring a smooth experience for users who heavily rely on screen readers. This exception recognizes the need for accommodating both screen reader users and those who prefer to use PSReadLine for enhanced PowerShell interactions.

Exception Rationale:
The compatibility warning currently displayed in PowerShell on GitHub, which advises users about the potential incompatibility between PSReadLine and screen readers, serves a purpose. It is designed to prevent conflicts between the two functionalities and provide a streamlined experience for users who require screen readers to navigate and interact with the GitHub repository through PowerShell.

Considerations:

Accessibility: The warning is beneficial for screen reader users, as it prevents potential conflicts and ensures that their experience is not compromised. For individuals who rely solely on screen readers for interaction, the presence of PSReadLine might interfere with the screen reader's behavior.

User Experience: The warning aims to provide guidance to users who might be unaware of the compatibility issues between PSReadLine and screen readers. By disabling PSReadLine by default, GitHub is attempting to prevent confusion and unexpected behavior for users relying on screen readers.

Balancing Accessibility and Features:
While accommodating users who prefer to use PSReadLine for enhanced interactions is important, it's equally crucial to ensure that the GitHub platform remains accessible to individuals with disabilities. Striking the right balance between catering to both user groups is the key challenge here.

Recommendation:
Instead of focusing on an outright exception that removes the warning, consider offering users a choice. GitHub could explore the implementation of a user-level setting within repository preferences or a command-line parameter that enables or disables the compatibility warning. This approach would empower users to make an informed decision based on their specific needs and preferences.

Conclusion:
While the warning regarding PSReadLine and screen reader compatibility may be perceived as an obstacle for some users, it's important to recognize its role in enhancing accessibility for individuals who rely on screen readers. Striking a balance between accessibility and feature enhancements is essential to provide an inclusive and versatile environment for all GitHub users.

Screenshot

Screenshot (49)

Environment data

PS Version: 5.1.19041.3031
PS HostName: Windows PowerShell ISE Host
PSReadLine Version: 
PSReadLine EditMode: Windows
OS: 10.0.19041.1 (WinBuild.160101.0800)
The handle is invalid.
At line:25 char:32
+     Write-Host "BufferWidth: $([console]::BufferWidth)"
+                                ~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : OperationStopped: (:) [], IOException
    + FullyQualifiedErrorId : System.IO.IOException
 
BufferWidth: 
The handle is invalid.
At line:26 char:33
+     Write-Host "BufferHeight: $([console]::BufferHeight)"
+                                 ~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : OperationStopped: (:) [], IOException
    + FullyQualifiedErrorId : System.IO.IOException
 
BufferHeight:

Steps to reproduce

1.Open PowerShell.
2.Navigate to a GitHub repository.
3.Interact with the repository using PowerShell commands.
4.Observe the compatibility warning about PSReadLine and screen reader usage.

Expected behavior

The warning about PSReadLine and screen reader usage should not be displayed by default. Users should have the option to enable or disable PSReadLine based on their preference, regardless of screen reader usage.

Actual behavior

When users with screen readers interact with GitHub repositories through PowerShell, the following compatibility warning is displayed:
Warning: PowerShell detected that you might be using a screen reader and has disabled PSReadLine for compatibility purposes. If you want to re-enable it, run 'Import-Module PSReadLine'.
Upon encountering this warning, users are informed that PowerShell has detected the possible use of a screen reader and, as a result, has disabled the PSReadLine module to ensure compatibility with screen reader software. The warning suggests that users can re-enable the PSReadLine module by running the command 'Import-Module PSReadLine'. However, by default, PSReadLine remains disabled, even if the user does not rely on a screen reader.

For users who are familiar with and rely on the capabilities provided by the PSReadLine module for an enhanced interactive experience within PowerShell, this warning results in PSReadLine being unavailable for use, regardless of their screen reader usage. This behavior can potentially slow down their workflow and hinder their efficiency when interacting with GitHub repositories via PowerShell.

In essence, the warning serves as a precautionary measure to prevent potential conflicts between the PSReadLine module and screen readers. However, it restricts the flexibility of users who wish to continue using PSReadLine's features while also relying on other methods for accessibility, such as screen readers.

The current behavior underscores the challenge of finding a balance between accessibility and feature enhancement, as it prioritizes screen reader compatibility at the expense of users who could benefit from both PSReadLine and screen reader capabilities. It highlights the need for a more flexible approach that allows users to enable or disable the PSReadLine module based on their individual preferences and requirements.

@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs-Triage 🔍 It's a new issue that core contributor team needs to triage. label Aug 17, 2023
@microsoft-github-policy-service microsoft-github-policy-service bot removed the Needs-Triage 🔍 It's a new issue that core contributor team needs to triage. label Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant