-
-
Notifications
You must be signed in to change notification settings - Fork 629
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 documentation formatting #17121
Fix documentation formatting #17121
Conversation
WalkthroughThe documentation in the Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
Strangely, the issue in the key commands document is not fixed (on appVeyor artifacts). |
@CyrilleB79 - could you open an issue to explain the problem being faced more thoroughly? |
@seanbudd this PR is now ready. I have opened #17159 to describe the issue with more details. After merging last beta, the issue described in #17121 (comment) is not present anymore; I do not know why. In the meantime, the translation freeze period has started. Since it is quite long (more than usual), I wonder if you would still accept this PR against beta. If not, let me know and I'll rebase on master. |
Please note that this change should have no impact for translators using the new framework to translate the user guide through Crowdin. For translators still using the old framework (SVN), it would have an impact, but I guess that new changes won't be merged anymore in SVN. So no problem. |
Closing tag issue found while reviewing ja user guide following @nishimotz's message on the translators mailing list.
Link to issue number:
Fixes #17159
Summary of the issue:
Commands Quick Reference includes text that was not intended to be included, due to missing closing tag
<!-- KC:endInclude -->
Description of user facing changes
The Commands Quick Reference will no longer include text unrelated to shortcut keys.
Description of development approach
Added the closing tag in the User Guide.
Testing strategy:
Check the newly generated Commands Quick Reference.
Known issues with pull request:
None
Code Review Checklist:
Summary by CodeRabbit