NEWS

---

document 4.0.0.9000

• FIXME

document 4.0.0 (2023-06-14)

• Removed examples for internal functions from the internal documentation (as requested by CRAN).
• Fixed broken links in README.Rmd and DESCRIPTION.
• Moved get_lines_between_tags() to package fritools.

document 3.3.4 (2022-08-19)

• Using suggested packages conditionally only.

document 3.3.3 (2022-03-30)

• Fixed test for html output failing on CRAN.

document 3.3.2 (2021-05-12)

• Fixed failing test for html output.

document 3.3.1 (2021-03-31)

• Fixed failing tests on CRAN: callr::rcmd_safe calls R CMD Rdconv --type=txt mysteriously fail (it cuts examples off), so we now test against --type=html, which keeps working. We now use tools::Rd2txt instead of callr::rcmd_safe.
• Now importing package fritools, where the functions from 3.3.0 now live.

document 3.3.0 (2020-10-30)

• Fixed failing test on r-patched-solaris-x86 by adding and exporting test helper functions is_running_on_fvafrcu_machines(), is_running_on_gitlab_com(), set_RUN_R_TESTS() and `get_RUN_R_TESTS()'. The docs of which are internal.

document 3.2.0 (2020-01-11)

• Tagged docs for get_dpd() and get_lines_between_tags() as internal.
• README.Rmd now links to gitlab.com

document 3.1.0 (2018-11-25)

• Now deleting tagged lines only if there are any.

document 3.0.2 (2018-09-13)

• Patched failing "CRAN Package Check Results for Package document".
• Skipping most tests on CRAN.

document 3.0.0 (2018-02-11)

• Added a fix to make the evaluation of whether or not/how we pass R CMD check more stable by using rcmdcheck internally. This causes the check_result-item of the list returned by document() to change: it is now the return value of rcmdcheck::rcmdcheck() instead of the return value of callr::rcmd_safe("check", ...).
• The (internal) functions
  • is_Rd_file
  • display_Rd
  • fake_package
  • check_package
  • sort_unlocale
  • alter_description_file
  • Rd_txt_RUnit are not exported any longer.

document 2.2.1 (2018-01-13)

• Fixed internal file parsing.
• Exported function get_lines_between_tags().

document 2.2.0 (2017-12-09)

• Marked alter_descprition_file() as deprecated, please use CRAN package desc by Gabor Csardi instead.
  Internally, alter_descprition_file() is not used any longer. It just lingers as it was exported in version 2.1.0.
• alter_descprition_file() now keeps whitespace, making it possible to pass newline characters, for example for the Authors@R field.

document 2.1.0 (2017-08-18)

• Fix man() to now work with RStudio.
• Add and export a new function alter_description_file(). It serves as a replacement for the internal add_depenedencies_to_description(), and straightens the former internal clean_descprition() which used [write|read]Lines() instead of [write|read].dcf() and is now exported as clean_descprition_file().

document 2.0.0 (2017-08-04)

• document() now throws an error if the temporary package does not pass R CMD check without errors, warnings or notes.
  • Added argument 'stop_on_check_not_passing'. Set to FALSE to issue a warning() instead of throwing an error.
  • Added argument 'check_as_cran' to use the --as-cran flag with R CMD check, document() then assumes a single NOTE (on the CRAN incoming feasibility) to be okay.

document 1.2.1 (2017-07-07)

• Check for RStudio in man().
• Fix return status of write_the_docs().

document 1.2.0 (2017-06-01)

• Enhance documenation.

document 1.1.0 (2017-05-19)

• Use the input file's basename instead of the temporary package's name as basename for the output files.
• Only return output file paths if the according file exists.

document 1.0.0 (2017-05-08)

• First release. See https://github.com/fvafrCU/document for any changes before.