Skip to content

Add documentation index URL to inline help #1628

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.

Sign up for GitHub

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

Open
rolandwalker wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −1
Open

Add documentation index URL to inline help #1628

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
Upcoming (TBD)
==============

Features
---------
* Add documentation index URL to inline help.


1.57.0 (2026/02/25)
==============

Expand Down
1 change: 1 addition & 0 deletions mycli/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
DOCS_URL = 'https://mycli.net/docs'
3 changes: 2 additions & 1 deletion mycli/packages/special/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import os
from typing import Callable

from mycli.constants import DOCS_URL
from mycli.packages.sqlresult import SQLResult

try:
Expand Down Expand Up @@ -165,7 +166,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, status=f'Docs index — {DOCS_URL}')]


def show_keyword_help(cur: Cursor, arg: str) -> list[SQLResult]:
Expand Down