From f7ecafebf898d7c5f6825a48ffecc79a300ebc9e Mon Sep 17 00:00:00 2001 From: Managor <42655600+Managor@users.noreply.github.com> Date: Mon, 1 Dec 2025 01:53:57 +0200 Subject: [PATCH] *: fix help inconsistencies (#19705) --- pages/common/cjxl.md | 2 +- pages/common/deepseek.md | 2 +- pages/common/djxl.md | 2 +- pages/common/docker-inspect.md | 8 ++++---- pages/common/docker-rmi.md | 8 ++++---- pages/common/docker-start.md | 8 ++++---- pages/common/docker-system.md | 8 ++++---- pages/common/irssi.md | 8 ++++---- pages/common/transmission-create.md | 2 +- pages/linux/kwriteconfig5.md | 8 ++++---- 10 files changed, 28 insertions(+), 28 deletions(-) diff --git a/pages/common/cjxl.md b/pages/common/cjxl.md index a6f974bc0d..5c61a62e31 100644 --- a/pages/common/cjxl.md +++ b/pages/common/cjxl.md @@ -12,6 +12,6 @@ `cjxl --distance 0 --effort 9 {{path/to/image.ext}} {{path/to/output.jxl}}` -- Display an extremely detailed help page: +- Display an extremely detailed help: `cjxl {{[-h -v -v -v -v|--help --verbose --verbose --verbose --verbose]}}` diff --git a/pages/common/deepseek.md b/pages/common/deepseek.md index 615993c1b3..c946ce9c64 100644 --- a/pages/common/deepseek.md +++ b/pages/common/deepseek.md @@ -23,6 +23,6 @@ `deepseek --local` -- Show help information: +- Display help: `deepseek --help` diff --git a/pages/common/djxl.md b/pages/common/djxl.md index cbe6f1cd7e..bfbbbbf7c6 100644 --- a/pages/common/djxl.md +++ b/pages/common/djxl.md @@ -8,6 +8,6 @@ `djxl {{path/to/image.jxl}} {{path/to/output.ext}}` -- Display an extremely detailed help page: +- Display an extremely detailed help: `djxl {{[-h -v -v -v -v|--help --verbose --verbose --verbose --verbose]}}` diff --git a/pages/common/docker-inspect.md b/pages/common/docker-inspect.md index 2c313bb951..0d57618552 100644 --- a/pages/common/docker-inspect.md +++ b/pages/common/docker-inspect.md @@ -3,10 +3,6 @@ > Return low-level information on Docker objects. > More information: . -- Display help: - -`docker inspect` - - Display information about a container, image, or volume using a name or ID: `docker inspect {{container|image|ID}}` @@ -30,3 +26,7 @@ - Display all port bindings: `docker inspect {{[-f|--format]}} '\{\{range $p, $conf := .NetworkSettings.Ports\}\} \{\{$p\}\} -> \{\{(index $conf 0).HostPort\}\} \{\{end\}\}' {{container}}` + +- Display help: + +`docker inspect` diff --git a/pages/common/docker-rmi.md b/pages/common/docker-rmi.md index 4f380950e8..c97e6f24fd 100644 --- a/pages/common/docker-rmi.md +++ b/pages/common/docker-rmi.md @@ -3,10 +3,6 @@ > Remove Docker images. > More information: . -- Display help: - -`docker rmi` - - Remove one or more images given their names: `docker rmi {{image1 image2 ...}}` @@ -18,3 +14,7 @@ - Remove an image without deleting untagged parents: `docker rmi --no-prune {{image}}` + +- Display help: + +`docker rmi` diff --git a/pages/common/docker-start.md b/pages/common/docker-start.md index d9a12bc94a..a59407c489 100644 --- a/pages/common/docker-start.md +++ b/pages/common/docker-start.md @@ -3,10 +3,6 @@ > Start stopped containers. > More information: . -- Display help: - -`docker start --help` - - Start a Docker container: `docker start {{container}}` @@ -18,3 +14,7 @@ - Start one or more containers: `docker start {{container1 container2 ...}}` + +- Display help: + +`docker start --help` diff --git a/pages/common/docker-system.md b/pages/common/docker-system.md index fe4f79b608..d279b235b9 100644 --- a/pages/common/docker-system.md +++ b/pages/common/docker-system.md @@ -3,10 +3,6 @@ > Manage Docker data and display system-wide information. > More information: . -- Display help: - -`docker system` - - Show Docker disk usage: `docker system df` @@ -34,3 +30,7 @@ - Display system-wide information: `docker system info` + +- Display help: + +`docker system` diff --git a/pages/common/irssi.md b/pages/common/irssi.md index 09c3f300a6..8749a1bcfd 100644 --- a/pages/common/irssi.md +++ b/pages/common/irssi.md @@ -11,10 +11,6 @@ `irssi {{[-c|--connect]}} {{irc.example.com}} {{[-p|--port]}} {{port}}` -- Display help: - -`irssi {{[-?|--help]}}` - - Join a channel: `/join {{#channelname}}` @@ -26,3 +22,7 @@ - Exit the application cleanly and quitting any server(s): `/quit` + +- Display help: + +`irssi {{[-?|--help]}}` diff --git a/pages/common/transmission-create.md b/pages/common/transmission-create.md index 7f2f2b2ba8..f7f2d256fc 100644 --- a/pages/common/transmission-create.md +++ b/pages/common/transmission-create.md @@ -20,6 +20,6 @@ `transmission-create {{[-o|--outfile]}} {{path/to/example.torrent}} {{[-t|--tracker]}} {{tracker_url1}} {{[-t|--tracker]}} {{tracker_url2}} {{path/to/file_or_directory}}` -- Display help page: +- Display help: `transmission-create {{[-h|--help]}}` diff --git a/pages/linux/kwriteconfig5.md b/pages/linux/kwriteconfig5.md index 1879c51bf5..e635b1b52f 100644 --- a/pages/linux/kwriteconfig5.md +++ b/pages/linux/kwriteconfig5.md @@ -3,10 +3,6 @@ > Write KConfig entries for KDE Plasma. > More information: . -- Display help: - -`kwriteconfig5 --help` - - Set a global configuration key: `kwriteconfig5 --group {{group_name}} --key {{key}} {{value}}` @@ -30,3 +26,7 @@ - Configure KRunner to open with the Meta (Command/Windows) global hotkey: `kwriteconfig5 --file {{~/.config/kwinrc}} --group {{ModifierOnlyShortcuts}} --key {{Meta}} "{{org.kde.kglobalaccel,/component/krunner_desktop,org.kde.kglobalaccel.Component,invokeShortcut,_launch}}"` + +- Display help: + +`kwriteconfig5 --help`