[Libreoffice-bugs] [Bug 103419] Description of SWITCH function is missing info, has confusing wording

[bugzilla-daemon at bugs.documentfoundation.org]

https://bugs.documentfoundation.org/show_bug.cgi?id=103419

Mihkel Tõnnov <mihhkel at gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Blocks|80430                       |

--- Comment #5 from Mihkel Tõnnov <mihhkel at gmail.com> ---
(In reply to sdc.blanco from comment #4)
> @Mikhel -- Just to be sure -- you are referring to the "Function Wizard"
> (Ctrl-F2) in Calc and the "explanation" provided if the SWITCH function is
> selected.  Is that correctly understood?

Both the Function Wizard and the tooltip that's shown when one starts typing
=Switch in a cell.

> Also please see: 
> https://help.libreoffice.org/7.1/en-US/text/scalc/01/func_switch.html 
> (produced in 2019/20).
> 
> Maybe some of that text can be used in a revised explanation.  (The problem
> that you have reported is still present in 7.1.0.0.alpha.)

Very good that at least the Help now documents this.

> > A new field should be added for the default value in the Functions wizard.
> > 
> > Description for "expression" field should be slightly changed as well.
> > Currently: "Value that will be compared against value1-valueN."
> > Better: "Value that will be compared against value1...value30." (to remove
> > possible ambiguity of the dash/minus sign)De
> 
> I could not find this in Functions Wizard.

That's exactly the point ;)

> (This is not exactly a "documentation" problem -- because it is in UI, but
> in this case I should be able to help, once we have located what should be
> changed and to what.)

Indeed, bug 80430 is about gaps in Help - but this bug is about a "gap" in UI.
Removed reference to 80430.

Simplest way to solve this here bug would be to change/amend a few text strings
in the UI, most importantly the description of the function:
- "Checks 1 or more values and returns a result corresponding to the first
value equal to the given expression."
+ "Tests an expression against a list of values and returns the result
corresponding to the first value that matches the expression. Optionally, a
default result may be given instead of the final value-result pair, to be
returned if none of the values match the expression."

For added clarity, the following two could be changed as well:
1) The description of Result2...Result127 (NB: only starting from 2nd - not
sure how easily this can be done):
- "Value to return when corresponding value argument matches expression."
+ "Value to return when corresponding value argument matches expression, or
alternatively a default value to return."
2) The description of Expression:
- "Value that will be compared against value1-valueN."
+ "Value that will be compared against value1...value127."


Referenced Bugs:

https://bugs.documentfoundation.org/show_bug.cgi?id=80430
[Bug 80430] [META] Documentation gap for new features
-- 
You are receiving this mail because:
You are the assignee for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/libreoffice-bugs/attachments/20201109/770a1eb9/attachment.htm>