ycphs / openxlsx

openxlsx - a fast way to read and write complex xslx files

https://ycphs.github.io/openxlsx/

Other

226 stars 75 forks source link

Update writeFormula.Rd #322

Closed christianbraathen closed 2 years ago

christianbraathen commented 2 years ago

Clarifying that arguments must be comma-separated.

codecov-commenter commented 2 years ago

Codecov Report

Merging #322 (76b4f18) into master (a4c6072) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #322   +/-   ##
=======================================
  Coverage   67.76%   67.76%           
=======================================
  Files          34       34           
  Lines        8931     8931           
=======================================
  Hits         6052     6052           
  Misses       2879     2879

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 110fb4f...76b4f18. Read the comment docs.

JanMarvin commented 2 years ago

Hi @christianbraathen, thanks for the pull request.The change should be made in the roxygen2 tag in the R file. Once it is added, you should run roxygen2. This will generate the man page (the one you have edited). If you want to, more details in the description or examples section would be welcome too.

christianbraathen commented 2 years ago

Hi @JanMarvin ! It's the first time I contribute to a package. Would you mind giving me a quick description with code on how to reproduce the docs properly? Then I'll create another PR.

JanMarvin commented 2 years ago

Sure. Just add it here: https://github.com/ycphs/openxlsx/blob/110fb4fec0a461a2367dabf8f2c5f203b99f977d/R/writeData.R#L433-L518

Afterwards you run roxygen2 (roxygen2::roxygenize() (check if that updates the man page after installation) or ctrl+shift+D in Rstudio). This ensures that the man pages are updated with code changes.