From 1f16ca5e5cca7dd7e2fa793099664fbf8824cb02 Mon Sep 17 00:00:00 2001 From: ocornut Date: Wed, 19 Nov 2025 17:12:49 +0100 Subject: [PATCH] Docs: update ShowUserGuide() + PR guidelines. (#9071) --- .github/pull_request_template.md | 6 ++++-- imgui_demo.cpp | 10 +++++----- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 796ec0b9e..d40b14ccf 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,7 +2,9 @@ 1. PLEASE CAREFULLY READ: [Contributing Guidelines](https://github.com/ocornut/imgui/blob/master/docs/CONTRIBUTING.md) -2. Make sure you're using a special branch just for this pull request. (Sometimes people unknowingly use a default branch, then later update that branch, which updates the pull request with the other changes if it hasn't been merged yet.) +2. **Make sure you're using a special branch just for this pull request**. (In git, 1 PR = 1 branch. If you update the branch the PR will be updated.) -3. Clear this template before submitting your PR. +3. Consider running the [imgui_test_suite](https://github.com/ocornut/imgui_test_engine) or adding new tests to test for expected behaviors. + +4. Clear this template before submitting your PR. diff --git a/imgui_demo.cpp b/imgui_demo.cpp index 6a16f7ff3..92857aa3f 100644 --- a/imgui_demo.cpp +++ b/imgui_demo.cpp @@ -8641,11 +8641,11 @@ void ImGui::ShowUserGuide() ImGuiIO& io = GetIO(); BulletText("Double-click on title bar to collapse window."); BulletText( - "Click and drag on lower corner to resize window\n" - "(double-click to auto fit window to its contents)."); + "Click and drag on lower corner or border to resize window.\n" + "(double-click to auto fit window to its contents)"); BulletText("Ctrl+Click on a slider or drag box to input value as text."); BulletText("Tab/Shift+Tab to cycle through keyboard editable fields."); - BulletText("Ctrl+Tab to select a window."); + BulletText("Ctrl+Tab/Ctrl+Shift+Tab to focus windows."); if (io.FontAllowUserScaling) BulletText("Ctrl+Mouse Wheel to zoom window contents."); BulletText("While inputting text:\n"); @@ -8658,10 +8658,10 @@ void ImGui::ShowUserGuide() Unindent(); BulletText("With keyboard navigation enabled:"); Indent(); - BulletText("Arrow keys to navigate."); + BulletText("Arrow keys or Home/End/PageUp/PageDown to navigate."); BulletText("Space to activate a widget."); BulletText("Return to input text into a widget."); - BulletText("Escape to deactivate a widget, close popup, exit child window."); + BulletText("Escape to deactivate a widget, close popup,\nexit a child window or the menu layer, clear focus."); BulletText("Alt to jump to the menu layer of a window."); Unindent(); }