Bug 160300 - The help of the SF_Calc ImportFromCSVFile is to be improved about the filteroptions parameter
Summary: The help of the SF_Calc ImportFromCSVFile is to be improved about the filtero...
Status: NEW
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
7.6.5.2 release
Hardware: All All
: medium enhancement
Assignee: Not Assigned
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-03-21 11:07 UTC by Eric Champy
Modified: 2024-03-21 11:43 UTC (History)
2 users (show)

See Also:
Crash report or crash signature:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Eric Champy 2024-03-21 11:07:47 UTC
Currently the help of this function does provides only the "filteroptions" parameter default values.

That does not help if you need to change these default values, specifically regarding  the MRG parameter, when you have to handle consecutive empty cells on the same row.

I suggest:
(a) to provide an example of the default filteroptions and meaning 
(b) to provide an example of a call to ImproveFromFile with an alternate  full filteroptions string where the MRG option is removed for example.

(c) possibly to provide a link to a page that describes fully the "filteroptions".

Thanks.

Reference: https://bugs.documentfoundation.org/show_bug.cgi?id=160257
Comment 1 Mike Kaganski 2024-03-21 11:28:42 UTC
The help page [1] has a note at the end of the 'ImportFromCSVFile' section, telling:

> To learn more about the CSV Filter Options, refer to the CSV Filter Options help page.

That points to [2], and that latter page is most complete, quite long documentation on all possible options to the filter.

NOTABUG.

[1] https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_calc.html?DbPAR=BASIC#bm_id381593685490638
[2] https://help.libreoffice.org/latest/en-US/text/shared/guide/csv_params.html
Comment 2 Mike Kaganski 2024-03-21 11:43:58 UTC
On the other hand:

1. The filter string, which is equivalent to the default assumptions, would be fine in front of the default assumptions list, like "The default filter, equivalent to "...", makes following assumptions:". This would help users realize, what exactly should go into the argument. The filter parameters documentation is created with command line use in mind; it shows examples of the command line use, where not only the filter arguments, but also the file extension, and the filter name, are all parts of the command line argument. It is not obvious for a user, that instead of "Text - txt - csv (StarCalc):44,34,76,1,1/5/2/1/3/1/4/1,1031,true,true", the expected filteroptions is only "44,34,76,1,1/5/2/1/3/1/4/1,1031,true,true".
2. The "To learn more about the CSV Filter Options, refer to the CSV Filter Options help page" should be at the bottom of the *filteroptions* agrument, not at the end of the function documentation, because it provides the necessary documentation for the said argument.

Setting to NEW.