Skip to content

Use fixed width font in the log viewer and the Python console #16321

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.

Sign up for GitHub

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

Jump to bottom
Merged
seanbudd merged 9 commits into from
May 7, 2024
Merged

Use fixed width font in the log viewer and the Python console #16321

seanbudd merged 9 commits into from
May 7, 2024

Conversation

@CyrilleB79
Copy link
Contributor

@CyrilleB79 CyrilleB79 commented Mar 18, 2024 •
edited
Loading

Link to issue number:

None

Summary of the issue:

Errors in the source code are indicated visually by "^" characters and has become more precise with Python 3.11.
However, the characters used in log viewer or python console have not a fixed width so:

  • visually, the wrong place of the source code is indicated
  • for blind people, going on the error marker ("^" characters) and pressing upArrow to jump at the same column position in the source code's line is useless because the cursor does not land in the same column.

Description of user facing changes

Use a fixed width font in the log viewer and in the Python console.
In the Python console, only the output field is impacted by vertical alignment considerations; however, for visual consistency I have modified both the input and the output fields.

Description of development approach

Change the log viewer's font to 'Consolas' which has fixed width and which is the one used in Notepad.

Testing strategy:

Manual tests:

  • Tested visually that the log viewer and the python console is using a fixed width.
  • Tested that vertical navigation is OK from error markers in a traceback
  • [ ]: Test required from a sighted person. (cc @Qchristensen or @gerald-hartig ?) to check the general appearance of the log viewer and python console for which I am not relevant.

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.

@CyrilleB79
Copy link
Contributor Author

CyrilleB79 commented Mar 20, 2024

The build can be downloaded here.

I would like to have a visual feedback of this new appearance of the log viewer before passing this PR to ready.
@Qchristensen, @gerald-hartig or anyone else sighted, would you mind provide a visual confirmation? Thanks.

@CyrilleB79 CyrilleB79 changed the title Use fixed width font in the log viewer Use fixed width font in the log viewer and the Python console Mar 28, 2024
@CyrilleB79
Copy link
Contributor Author

CyrilleB79 commented Apr 15, 2024

@Qchristensen or @gerald-hartig, could you please provide a visual feedback running this build, looking at the log viewer and the Python console?

Or I may provide screenshots if you want, hoping that the resolution of the picture will be OK. Let me know.

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Apr 16, 2024
@CyrilleB79 CyrilleB79 marked this pull request as ready for review May 2, 2024 14:24
@CyrilleB79 CyrilleB79 requested a review from a team as a code owner May 2, 2024 14:24
@CyrilleB79
Copy link
Contributor Author

CyrilleB79 commented May 2, 2024

This PR is ready on my side. Adding Quentin or Gerald as reviewers to have a visual feedback.

seanbudd
seanbudd reviewed May 6, 2024
View reviewed changes
@seanbudd
Copy link
Member

seanbudd commented May 6, 2024

The new font looks good to me, happy to hear what @gerald-hartig and @Qchristensen think as well

@seanbudd
Copy link
Member

seanbudd commented May 6, 2024

Test build: https://ci.appveyor.com/api/buildjobs/yvcqxx5o6nml3djr/artifacts/output%2Fnvda_snapshot_pr16321-31597%2C43c6c390.exe

@CyrilleB79 @seanbudd
Update user_docs/en/changes.t2t
d3d570a 
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
@gerald-hartig
Copy link
Contributor

gerald-hartig commented May 6, 2024

Looks good to me. Thanks for the link to the snapshot build @seanbudd

@seanbudd seanbudd added this to the 2024.3 milestone May 7, 2024
seanbudd
seanbudd reviewed May 7, 2024
View reviewed changes
@seanbudd seanbudd merged commit a0a2868 into nvaccess:master May 7, 2024
@CyrilleB79 CyrilleB79 deleted the logFont branch May 7, 2024 07:40
@AppVeyorBot
Copy link

AppVeyorBot commented May 7, 2024

  • Build execution time has reached the maximum allowed time for your plan (60 minutes).

See test results for failed build of commit df3c55c751

XLTechie pushed a commit to XLTechie/xlnvda that referenced this pull request May 10, 2024
@CyrilleB79
Use fixed width font in the log viewer and the Python console (nvacce…
57922c6 
…ss#16321)

CyrilleB79
Collaborator
CyrilleB79 commented on Mar 19 • 
Link to issue number:
None

Summary of the issue:
Errors in the source code are indicated visually by "^" characters and has become more precise with Python 3.11.
However, the characters used in log viewer or python console have not a fixed width so:

visually, the wrong place of the source code is indicated
for blind people, going on the error marker ("^" characters) and pressing upArrow to jump at the same column position in the source code's line is useless because the cursor does not land in the same column.
Description of user facing changes
Use a fixed width font in the log viewer and in the Python console.
In the Python console, only the output field is impacted by vertical alignment considerations; however, for visual consistency I have modified both the input and the output fields.

Description of development approach
Change the log viewer's font to 'Consolas' which has fixed width and which is the one used in Notepad.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seanbudd seanbudd seanbudd approved these changes

@SaschaCowley SaschaCowley Awaiting requested review from SaschaCowley SaschaCowley is a code owner automatically assigned from nvaccess/developers

@Qchristensen Qchristensen Awaiting requested review from Qchristensen

@gerald-hartig gerald-hartig Awaiting requested review from gerald-hartig

Assignees

No one assigned

Labels

conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. queued for merge

Projects

None yet

Milestone

2024.3

Development

Successfully merging this pull request may close these issues.

4 participants

@CyrilleB79 @seanbudd @gerald-hartig @AppVeyorBot