From f76f4f54d87e86775c29afe3a5948e04479df0d0 Mon Sep 17 00:00:00 2001 From: Roland Walker Date: Wed, 25 Feb 2026 04:59:21 -0500 Subject: [PATCH] add documentation index URL to inline help --- changelog.md | 1 + mycli/packages/special/main.py | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/changelog.md b/changelog.md index ff3eba3b..7c82df44 100644 --- a/changelog.md +++ b/changelog.md @@ -5,6 +5,7 @@ Features --------- * Add `\bug` command. * Let the `F1` key open a browser to mycli.net/docs and emit help text. +* Add documentation index URL to inline help. Bug Fixes diff --git a/mycli/packages/special/main.py b/mycli/packages/special/main.py index a6adb452..3d30d9d5 100644 --- a/mycli/packages/special/main.py +++ b/mycli/packages/special/main.py @@ -5,7 +5,7 @@ from typing import Callable import webbrowser -from mycli.constants import ISSUES_URL +from mycli.constants import DOCS_URL, ISSUES_URL from mycli.packages.sqlresult import SQLResult try: @@ -167,7 +167,7 @@ def show_help(*_args) -> list[SQLResult]: for _, value in sorted(COMMANDS.items()): if not value.hidden: result.append((value.command, value.shortcut, value.usage, value.description)) - return [SQLResult(results=result, headers=headers)] + return [SQLResult(results=result, headers=headers, postamble=f'Docs index — {DOCS_URL}')] def show_keyword_help(cur: Cursor, arg: str) -> list[SQLResult]: