Bug 427414 - --slider dialog needs documentation and usage instructions
Summary: --slider dialog needs documentation and usage instructions
Status: RESOLVED FIXED
Alias: None
Product: kdialog
Classification: Applications
Component: general (show other bugs)
Version: 20.08
Platform: Other Linux
: NOR normal
Target Milestone: ---
Assignee: Brad Hards
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2020-10-07 09:14 UTC by Tristan Miller
Modified: 2023-05-19 13:13 UTC (History)
3 users (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Tristan Miller 2020-10-07 09:14:30 UTC
Almost all of the dialog types offered by KDialog are sufficiently documented, either in the tutorial at <https://techbase.kde.org/Development/Tutorials/Shell_Scripting_with_KDE_Dialogs>, or else in the man page, or else by emitting usage instructions on the console when called with the wrong number of arguments.  The only exception is --slider, which is mentioned only in the man page, but without enough information to understand how it should be invoked.  And invoking --slider with only one argument results in a nonsensical slider dialog rather than displaying usage instructions.

To fix this problem, the following is required:

1. Add a section for --slider to the tutorial (probably as a subsection of §3.7)

2. When --slider is called with fewer than two or more than four arguments, KDialog should immediately quit with exit status 255 and the following message should be output:

Syntax: --slider text min_value max_value increment
Comment 1 Duncan 2022-06-26 23:11:18 UTC
Just trying to find some --slider documentation myself.

With a bit of experimentation I had guessed it was text/min/max/increment, but at least here...

kdialog --slider "test" 0 10 2

... increments by 1, not 2, and an increment of .1 or 0.1 increments by 1 as well, so it seems "increment" isn't doing what I expected and after not seeing information about that in the --help output or on the page linked in the README, here I am looking at bugs, still trying to confirm that "increment" is indeed the third argument (beyond text), and whether I'm formatting it correctly if so.
Comment 2 Duncan 2022-06-27 01:15:59 UTC
Not sure kdialog's currently maintained beyond "minimal life support" level (keeping it building and running, it is a native wayland app running on wayland, and I see hints of qt6 support in git so should hopefully outlast qt5).  See bug #455994 which I just filed for more on that:  https://bugs.kde.org/show_bug.cgi?id=455994
Comment 3 Bug Janitor Service 2023-05-05 20:28:45 UTC
A possibly relevant merge request was started @ https://invent.kde.org/documentation/develop-kde-org/-/merge_requests/289
Comment 4 Bug Janitor Service 2023-05-05 20:30:56 UTC
A possibly relevant merge request was started @ https://invent.kde.org/utilities/kdialog/-/merge_requests/24
Comment 5 Albert Astals Cid 2023-05-19 13:13:22 UTC
Git commit bd3082d7880db3e48f2c6113f04a28f837333831 by Albert Astals Cid, on behalf of shenleban tongying.
Committed on 19/05/2023 at 13:07.
Pushed by aacid into branch 'master'.

fix: slider's ticks and related doc
Related: bug 467867

M  +17   -15   src/kdialog.cpp
M  +1    -0    src/widgets.cpp

https://invent.kde.org/utilities/kdialog/commit/bd3082d7880db3e48f2c6113f04a28f837333831