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

Update liblouis to 3.31 #17080

Merged
merged 6 commits into from
Sep 4, 2024
Merged

Update liblouis to 3.31 #17080

merged 6 commits into from
Sep 4, 2024

Conversation

LeonarddeR
Copy link
Collaborator

@LeonarddeR LeonarddeR commented Aug 29, 2024

Preliminary note

Liblouis 3.31 is to be released on the 2nd of September

Link to issue number:

None

Summary of the issue:

Liblouis 3.31 is to be released soon. AMong new tables, this release contains a bug fix for Spanish causing digits to be presented incorrectly, see liblouis/liblouis#1624. CC @jmdaweb. Hence this pr is filed against beta.In my humble opinion, we are still early enough in the beta cycle to warrant this update.

Description of user facing changes

Update to Liblouis 3.31, adding new tables as mentioned in the changelog.

Description of development approach

Update the submodule, added and updated definitions in brailleTables.py

Testing strategy:

Running NVDA< ensured that the new and changed tables work.

Known issues with pull request:

None known

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

  • New Features

    • Upgraded LibLouis Braille translator to version 3.31.0, adding new Braille tables for Thai grade 1 and Greek international Braille with single-cell accented letters.
    • Updated eSpeak NG component to version 1.52-dev, now supporting Faroese and Xextan languages.
    • Enhanced command line options for better user experience during updates.
  • Bug Fixes

    • Resolved a bug related to back-translation of numbers in Spanish Braille.
  • Documentation

    • Updated documentation to reflect changes in Braille table names and versions.

@LeonarddeR
Copy link
Collaborator Author

Cc @codeofdusk who did the liblouis updates in the past.

@seanbudd seanbudd changed the base branch from beta to master September 2, 2024 01:06
@seanbudd seanbudd added this to the 2025.1 milestone Sep 2, 2024
@codeofdusk

This comment was marked as resolved.

@codeofdusk

This comment was marked as duplicate.

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Sep 2, 2024
@seanbudd
Copy link
Member

seanbudd commented Sep 3, 2024

@codeofdusk @LeonarddeR - we don't introduce risky changes, new features or dependency updates in the beta cycle unless they are important bug fixes.
Please see our release process docs - the beta cycle is for:

  • addressing regressions introduced in this release.
  • addressing a bug in a "must have" feature for this release.
  • addressing a critical Operating System (or software) change out of our control.

Generally we would expect these updates to happen early in the alpha cycle to ensure there is maximum testing before we release.

@codeofdusk
Copy link
Contributor

This PR does include an important bug fix:

this release contains a bug fix for Spanish causing digits to be presented incorrectly, see liblouis/liblouis#1624. CC @jmdaweb. Hence this pr is filed against beta.In my humble opinion, we are still early enough in the beta cycle to warrant this update.

@seanbudd
Copy link
Member

seanbudd commented Sep 3, 2024

Is this a bug fix for a recent regression? Most liblouis releases contain some level of bug fixes, we would still generally hold back from a late inclusion as regressions may be introduced with these bug fixes.

If we merge this late, and there's regressions within the bug fixes, we get caught in a bad cycle where we have to revert the update and extend the release cycle. Or even worse, we ship with regressions. If this is merged early in a release cycle, it can get adequate testing, and we can ship it with greater certainty that is doesn't introduce any regressions.

@codeofdusk
Copy link
Contributor

Per liblouis/liblouis#1574 (comment) this is new as of Liblouis 3.30 (NVDA 2024.3).

user_docs/en/changes.md Outdated Show resolved Hide resolved
@codeofdusk
Copy link
Contributor

Given @LeonarddeR stepping away (and inability to respond to mentions) I'm happy to take this over.

@codeofdusk
Copy link
Contributor

@seanbudd This PR is now ready for review against beta, but since I don't own it, I can't change its status.

@SaschaCowley SaschaCowley marked this pull request as ready for review September 3, 2024 01:47
@SaschaCowley SaschaCowley requested a review from a team as a code owner September 3, 2024 01:47
Copy link
Contributor

coderabbitai bot commented Sep 3, 2024

Walkthrough

The updates include an upgrade to the LibLouis Braille translator to version 3.31.0, introducing new Braille tables and refining existing descriptions. The eSpeak NG component has also been updated to version 1.52-dev, adding support for additional languages and enhancing command line options. Documentation has been revised to reflect these changes, ensuring clarity on the updated functionalities and features.

Changes

Files Change Summary
include/liblouis Updated to a new commit identifier, indicating a new version or state of the subproject.
projectDocs/dev/createDevEnvironment.md Updated LibLouis dependency version from 3.30.0 to 3.31.0.
source/brailleTables.py Modified listTables function to enhance descriptions of Braille tables, adding new entries and updates.
user_docs/en/changes.md Documented updates including LibLouis upgrade to 3.31.0, eSpeak NG upgrade to 1.52-dev, and bug fixes.

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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (6)
source/brailleTables.py (1)

633-635: New Thai grade 1 braille table added.

The addition of the Thai grade 1 table is a valuable expansion of the braille options for Thai users. The settings (input=False, contracted=True) are appropriate for a grade 1 table.

Consider adjusting the comment formatting for consistency:

-# Translators: The name of a braille table displayed in the
-# braille settings dialog.
+# Translators: The name of a braille table displayed in the braille settings dialog.
 addTable("th-g1.utb", _("Thai grade 1"), input=False, contracted=True)

This change aligns with the single-line comment style used for other table entries.

user_docs/en/changes.md (5)

Line range hint 6-10: Consider adding more context to the first bullet point.

The first bullet point about moving forward and backward by sentence in Microsoft Word and Outlook is clear, but it might be helpful to mention what the previous behavior was for comparison.


Line range hint 15-18: Consider clarifying the "multiple press gesture" setting.

The explanation of the new setting for configuring the timeout for multiple press gestures is clear, but it might be helpful to provide an example of when this would be used.


Line range hint 26-31: Consider adding more context about the experimental option.

The explanation of the new experimental option for browse mode focus behavior is clear, but it might be helpful to provide more context about why a user might want to enable this option.


Line range hint 36-41: Consider providing examples for some of these new commands.

The new commands for showing symbol replacement and context information are clearly explained, but providing examples of when these might be useful could enhance user understanding.


46-47: Consider expanding on the Python Console enhancement.

The new feature for the Python Console is briefly mentioned. It might be helpful to provide a bit more detail about how this improves usability for developers.

@AppVeyorBot
Copy link

See test results for failed build of commit e59d862e1a

@seanbudd seanbudd removed this from the 2025.1 milestone Sep 3, 2024
@LeonarddeR
Copy link
Collaborator Author

Given @LeonarddeR stepping away (and inability to respond to mentions) I'm happy to take this over.

Thanks @codeofdusk

user_docs/en/changes.md Outdated Show resolved Hide resolved
@codeofdusk
Copy link
Contributor

From news:

A change to the Spanish back-translation that went into the last release was reverted as it caused more problems than it solved.

@LeonarddeR
Copy link
Collaborator Author

If it is only back translation, then I guess it is of slightly less importance. Honestly I thought that it caused issues with forward translation.

@jmdaweb
Copy link
Sponsor

jmdaweb commented Sep 3, 2024

It causes issues with forward translation as well. The prefix for digits (# symbol) has disappeared on the spanish grade 1 table. This pr is quite urgent and should be included in the next beta. We have a lot of complains and users expect this bug to be fixed in 2024.4.

Co-authored-by: Leonard de Ruijter <[email protected]>
@codeofdusk
Copy link
Contributor

@SaschaCowley Please re-target this PR to the beta branch. I don't own this PR, so can't change its base branch.

@SaschaCowley SaschaCowley changed the base branch from master to beta September 4, 2024 00:38
@SaschaCowley SaschaCowley added this to the 2024.4 milestone Sep 4, 2024
@SaschaCowley SaschaCowley merged commit 9fdcdcd into nvaccess:beta Sep 4, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants