Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Weak documented Worksheet.write parameters #74

Open
ukolovda opened this issue Nov 23, 2021 · 1 comment
Open

Weak documented Worksheet.write parameters #74

ukolovda opened this issue Nov 23, 2021 · 1 comment

Comments

@ukolovda
Copy link
Contributor

In the Worksheet.write documentation I see description for format argument

# :call-seq:
# write(row, column [ , token [ , format ] ])

and
# The +format+ parameter is optional. It should be a valid Format object,
# See {"CELL FORMATTING"}[Format.html#label-CELL+FORMATTING]:

But many tests have extra parameters, or it have other type, i.e.:

worksheet2.write('B11', '=SUBTOTAL(9,B7:B10)', bold, 2100)

worksheet.write('A1', '="Café"', nil, 'Café')

Please document it more detailed.

@ukolovda
Copy link
Contributor Author

ukolovda commented Nov 23, 2021

It, seems, mostly have more arguments when used as wrapper for formulas

# :call-seq:
# write_formula(row, column, formula [ , format [ , value ] ] )

But there is exists other callы:

worksheet.write('A8', "internal:Fonts!A1", 'Fonts', format3)

or
worksheet.write('A9', "internal:'Named colors'!A1",
'Named colors', format3)

It have strange text prefix before format argument

@ukolovda ukolovda changed the title Undocumented Worksheet.write parameters Weak documented Worksheet.write parameters Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant