Bug 150299

Summary: Dim and Redim documentation has redundant type definition description
Product: LibreOffice Reporter: Mike Kaganski <mikekaganski>
Component: DocumentationAssignee: Not Assigned <libreoffice-bugs>
Status: RESOLVED INVALID    
Severity: normal CC: olivier.hallot
Priority: medium    
Version: unspecified   
Hardware: All   
OS: All   
Whiteboard:
Crash report or crash signature: Regression By:

Description Mike Kaganski 2022-08-08 06:54:05 UTC
In current Dim [1] and Redim [2] statements documentation, there are sections about definition of element types. They include block diagrams, type names, their limits (sometimes even incomplete, like not mentioning negatives and zero for floating point values), type characters ...

All that is conceptually wrong: the documentation should have a placeholder for the type, and the respective description should simply link to the respective dedicated documentation page [3] (which might be amended with missing bits like diagrams). The existing page [3] could possibly be even split into something about "use" of variables (it's even confusing, how *constants*, which are not variables at all, even fit into that page), and a dedicated page about the formal definition syntax.

Having the verbose redundant description on (Re)Dim pages makes wrong impression that the type definition there is somehow specific to arrays; and also makes the description less comprehensible (one wants to understand the array creation, but finds details about variable types). Why not put the detailed definition of a "name" then, with allowed/disallowed characters in names, and syntax for use of spaces in variable names? ;)

[1] https://help.libreoffice.org/7.4/en-US/text/sbasic/shared/03102100.html?DbPAR=BASIC
[2] https://help.libreoffice.org/7.4/en-US/text/sbasic/shared/03102101.html?DbPAR=BASIC
[3] https://help.libreoffice.org/7.4/en-US/text/sbasic/shared/01020100.html?DbPAR=BASIC
Comment 1 Mike Kaganski 2022-08-08 06:59:11 UTC
Oh I definitely needed a big cup of morning coffee before writing this. I was somehow looking for array definition, and just forgot that Dim is a generic definition of any variable ...