Closed matt-dray closed 2 years ago
create_a11ytable()
and generate_workbook()
are probably the right choices. Start with verbs. 'Create' implies building from scratch. 'Generate' implies the workbook is being created from some kind of input (i.e. an a11ytable). I like the idea of 'convert' as a verb, but I don't like the three words inconvert_to_workbook()
, while convert_workbook()
is ambiguous (converting from a workbook or to a workbook?).
Provide a deprecation warning to new_a11ytable()
and create_a11y_wb()
?
Need to be more descriptive and helpful to the user. These will be breaking. Suggest changing them for v0.1.0.
Functions
new_a11ytable()
tocreate_a11ytable()
(verb)create_a11y_wb()
toconvert_to_wb()
(the real purpose is to convert from a11ytable-class to Workbook-class), or simplycreate_workbook()
to mirrorcreate_a11ytable()
.insert_*()
functions:.insert_notes_statement
and.insert_blanks_message()
should have consistent suffix (this could have a knock-on effect for other functions that handle the message for blank cells, like.has_blanks_message()
and.get_start_row_blanks_message()
)?Arguments
content
toa11ytable
increate_a11y_wb()
(you're passing an a11ytable so call it that, also 'content' is too close to 'contents' as in the sheet type)x
in S3 functions (I think I used x by convention, but not helpful for user)?