ycphs / openxlsx

openxlsx - a fast way to read and write complex xslx files
https://ycphs.github.io/openxlsx/
Other
220 stars 73 forks source link

Mildly misleading function description #438

Open ERF4 opened 11 months ago

ERF4 commented 11 months ago

The description for the worksheetOrder() function reads: "Get/set order of worksheets in a Workbook object". However, this mildly contradicts the actual behavior of the function, described in the Details section as follows: "This function does not reorder the worksheets within the workbook object, it simply shuffles the order when writing to file."

It would be helpful if the description reflected the actual behavior, so it could be worded more like this: "Get/set the order in which worksheets will be written to a file from a Workbook object"