[Libreoffice-bugs] [Bug 129436] New: Unclear documentation of InStr "Compare" parameter

[bugzilla-daemon at bugs.documentfoundation.org]

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

            Bug ID: 129436
           Summary: Unclear documentation of InStr "Compare" parameter
           Product: LibreOffice
           Version: 6.5.0.0.alpha0+ Master
          Hardware: All
                OS: All
            Status: UNCONFIRMED
          Severity: normal
          Priority: medium
         Component: Documentation
          Assignee: libreoffice-bugs at lists.freedesktop.org
          Reporter: jim.avera at gmail.com
                CC: olivier.hallot at libreoffice.org

Description:
The documentation for Basic function "InStr" says

  "To avoid a run-time error, do not set the Compare parameter if the first
return parameter is omitted."

What does "return parameter" refer to here?   

Probably the wording should be clarified to give the parameter's name (is it
'Start' ?) and not say "return" unless the parameter is passed by value.

Note: None of the parameters are documented to return anything, although they
are passed by reference (since not declared 'ByVal').

Steps to Reproduce:
1. Search for "InStr" in the Help

Actual Results:
.

Expected Results:
.


Reproducible: Always


User Profile Reset: No



Additional Info:

-- 
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/20191216/c960c814/attachment-0001.htm>