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

fix up documentation changes for 2024.2 #16423

Open
wants to merge 7 commits into
base: beta
Choose a base branch
from
Open

Conversation

seanbudd
Copy link
Member

No description provided.

@seanbudd seanbudd added this to the 2024.2 milestone Apr 18, 2024
@seanbudd seanbudd changed the base branch from master to beta April 18, 2024 05:56
@CyrilleB79
Copy link
Collaborator

In the blurb, I can read:

When active, the braille display shows exactly what NVDA prepares to speak.

IMO, "prepare to speak" is not clear for end-users.

We may just write:
"When active, the braille display shows exactly what NVDA speaks."

For the blurb, it's not important to take into account corner cases such as the "speech off" case.

@CyrilleB79
Copy link
Collaborator

By the way, also for the subsequent change log item, we may remove "prepare to".

The User Guide is more precise and indicates:

When display speech output is selected, the braille display will show what NVDA speaks, or would have spoken if speech mode was set to "talk"

But this corner case does not need to be presented in the change log IMO.

@CyrilleB79
Copy link
Collaborator

By the way, if this PR gathers all minor changes needed in the documentation, in the User Guide, could you add a period at the end of the following sentence?

When display speech output is selected, the braille display will show what NVDA speaks, or would have spoken if speech mode was set to "talk"

@seanbudd seanbudd marked this pull request as ready for review April 22, 2024 06:21
@seanbudd seanbudd requested review from a team as code owners April 22, 2024 06:21
@seanbudd seanbudd requested review from Qchristensen and michaelDCurran and removed request for a team April 22, 2024 06:21
@seanbudd
Copy link
Member Author

thanks @CyrilleB79 for the catches

@seanbudd seanbudd changed the title fix up release blurb fix up documentation changes for 2024.2 Apr 22, 2024
Qchristensen
Qchristensen previously approved these changes Apr 22, 2024
Copy link
Member

@Qchristensen Qchristensen left a comment

Choose a reason for hiding this comment

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

Reads well

michaelDCurran
michaelDCurran previously approved these changes Apr 22, 2024
@seanbudd seanbudd added conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. queued for merge labels Apr 23, 2024
@CyrilleB79
Copy link
Collaborator

@seanbudd while at it, could you also fix here the table formatting issues described by @k-kolev1985 in this message on the translators mailing list?
Thanks.

@k-kolev1985
Copy link

Also, I've noticed that some heading titles (marked with ====) are missing a space between the text and the ==== sequence. I'm not sure if this causes a formatting breakage or not, but I'm reporting it just in case. Unfortunately, I did not wrote down on which lines in the documentations are those missing spaces.

@seanbudd
Copy link
Member Author

@CyrilleB79 - I've fixed this up, thanks @k-kolev1985 for reporting this

@k-kolev1985 - I don't think this is causes any formatting issues, and also should be fixed when we migrate to markdown next week.

user_docs/en/changes.t2t Outdated Show resolved Hide resolved
user_docs/en/changes.t2t Outdated Show resolved Hide resolved
user_docs/en/changes.t2t Outdated Show resolved Hide resolved
Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>
Copy link
Collaborator

@CyrilleB79 CyrilleB79 left a comment

Choose a reason for hiding this comment

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

In the User Guide:
"in a larger step" -> "in larger steps"

Please check all occurrences.

user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved
user_docs/en/userGuide.t2t Outdated Show resolved Hide resolved
Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>
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. queued for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants