From 680739bccc247c52e52b39fd1caee400785895e1 Mon Sep 17 00:00:00 2001 From: Waldir Leoncio Date: Mon, 16 Dec 2019 18:42:50 +0100 Subject: [PATCH] Added CHANGELOG, improved other docs --- CHANGELOG.md | 3 +++ R/ownNum2Str.R | 1 + TODO.md | 11 ++++++++++- 3 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..41c51bd --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# Changelog + +(no stable releases have been published yet) \ No newline at end of file diff --git a/R/ownNum2Str.R b/R/ownNum2Str.R index 4ebff24..e063df3 100644 --- a/R/ownNum2Str.R +++ b/R/ownNum2Str.R @@ -1,4 +1,5 @@ #' @title Own number to string +#' @description Converts numbers to strings #' @param number number #' @note On Matlab, if number is NaN the output is 'NaN'. Here, the output will be an error. Also, the function belo expects "number" to have length one, whereas Matlab accepts vectors. #' @export diff --git a/TODO.md b/TODO.md index 9c64ccd..6f71a14 100644 --- a/TODO.md +++ b/TODO.md @@ -1,4 +1,6 @@ -# Minimum requirements for next stable release +# Roadmap for next stable release + +## Minimum requirements For the first stable release of rBAPS, the following features should be implemented: @@ -10,6 +12,13 @@ For the first stable release of rBAPS, the following features should be implemen Note to contributors: as tasks get finished, please update this file with an `x` and keep it there. This should help us fill out a changelog for an eventual stable release. +## Wishlist + +The list below contains non-essential but nice-to-have tasks for the next stable release. + +- [ ] Uniformize capitalization of function names +- [ ] Uniformize capitalization of function arguments + # Known pitfalls The following behavioral differences have been detected between the Matlab functions and their R counterparts. In order to save time, these differences will not be addressed, since they could require extensive reworking of a function. However, such differences may very well cause unexpected problems in some situations, which is why compiling this list is so important. The list below might provide a good starting point for identifying and fixing bugs: