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
base: beta
Are you sure you want to change the base?
Conversation
In the blurb, I can read:
IMO, "prepare to speak" is not clear for end-users. We may just write: For the blurb, it's not important to take into account corner cases such as the "speech off" case. |
By the way, also for the subsequent change log item, we may remove "prepare to". The User Guide is more precise and indicates:
But this corner case does not need to be presented in the change log IMO. |
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?
|
thanks @CyrilleB79 for the catches |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reads well
@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? |
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. |
c32c922
@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. |
Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>
There was a problem hiding this 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.
Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>
No description provided.