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

Documentation improvements #717

Merged
merged 22 commits into from
Aug 6, 2023
Merged

Documentation improvements #717

merged 22 commits into from
Aug 6, 2023

Conversation

olivroy
Copy link
Collaborator

@olivroy olivroy commented Aug 5, 2023

This is a couple of documentation improvements. Addresses #681

  • Merges some add / remove documentation together in a single .Rd file
  • get/set together
  • Removes duplicated entries in the pkgdown index
  • Removes redundant @seealso since there is already crossreferences with the @family tag
  • Rename R/openxlsx2.R -> R/openxlsx2-package.R
  • Remove some mentions to write_data(), write_datatable() in favour of wb_add_data(), wb_add_data_table()
  • workbook_grouping.Rd wb_grouping.Rd
  • Rename helper functions so that test file and R file align
  • Move get_cell_refs tests in test-converters.R as get_cell_refs lives in converters.R

This may not be as focused or thorough as I wished it to be, but these are leftovers that I think can be useful.

Edit: maybe wb_set_col_widths() could be wb_add_col_widths()?

@JanMarvin
Copy link
Owner

JanMarvin commented Aug 5, 2023

Edit: maybe wb_set_col_widths() could be wb_add_col_widths()?

This might be a good idea indeed.

[Edit:] but then again it should be similar to wb_set_row_heights(). Therefore better just leave it the way it is.

@olivroy olivroy changed the title Documentation improves Documentation improvements Aug 6, 2023
@JanMarvin
Copy link
Owner

Thanks for the pull requests! Your really helping in a long time overlooked area of the package

@JanMarvin JanMarvin merged commit a82d871 into JanMarvin:main Aug 6, 2023
9 checks passed
@olivroy olivroy deleted the pkgdown-index branch August 21, 2023 14:24
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

Successfully merging this pull request may close these issues.

2 participants