Skip to content

Advertise forward-slash /command forms in /help#1970

Open
rolandwalker wants to merge 1 commit into
mainfrom
RW/prefer-forward-slash-in-help-output
Open

Advertise forward-slash /command forms in /help#1970
rolandwalker wants to merge 1 commit into
mainfrom
RW/prefer-forward-slash-in-help-output

Conversation

@rolandwalker

Copy link
Copy Markdown
Contributor

Description

This is a quite limited approach, which meets the requirements by primarily tweaking the presentation only.

Why take a limited approach? Because it implicitly keeps track of backward compatibility, for example, which commands can be entered without punctuation at all: use mysql.

In a followup it would be desirable to rewrite register_special_command() to take more parameters, such as "can be entered without punctuation", and a complete helpdoc to be returned on /help /command.

Preparation for release 2.0.

Example:

last image

Checklist

  • I added this contribution to the changelog.md file.
  • I added my name to the AUTHORS file (or it's already there).
  • To lint and format the code, I ran
    uv run ruff check && uv run ruff format && uv run mypy --install-types .

This is a quite limited approach, which meets the requirements by
primarily tweaking the presentation only.

Why take a limited approach?  Because it implicitly keeps track of
backward compatibility, for example, which commands can be entered
without punctuation at all: "use mysql".

In a followup it would be desirable to rewrite
register_special_command() to take more parameters, such as "can be
entered without punctuation", and a complete helpdoc to be returned on
"/help /command".
@rolandwalker rolandwalker self-assigned this Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant