---
title: Release notes of package wyz.code.rdoc
author: Fabien GELINEAU
date: 2020-04-22
output: 
  rmarkdown::html_vignette:
    number_sections: false
    toc: false
    css: style.css
vignette: >
  %\VignetteIndexEntry{ Release notes of package wyz.code.rdoc }
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
source('vignette-common.R')
```

<img src='images/rdoc-hex.png' alt='offensive programming - R documentation' style='width:30%'/>

# Release 1.1.16 - April 22nd 2020

1. added `r citefun('shortcuts')` function
1. added `r citefun('getTypeLabel')` function
1. added test for `r citefun('shortcuts')` function
1. modified `r citefun('InputContext')` function
1. modified `r citefun('beautify')` function
1. modified `r citefun('extractObjectOPInformation')` function
1. modified `r citefun('generatePublicFieldParagraph')` function
1. modified `r citefun('generatePublicMethodParagraph')` function
1. modified `r citefun('GenerateTable')` function
1. added `r citefile('shortcuts.Rd')` manual page
1. updated all documentation files
1. upgraded and updated vignette files
1. test, `r citefigure('20.6s')`, OK: `r citefigure('824')`
1. R CMD check,  `r citefigure('54.6s')`, 0 errors ✓ | 0 warnings ✓ | 0 notes ✓

# Release 1.1.8 - January 2020 

Main improvements are 

1. rebuild entirely manual page generation
1. added a way to generate a manual page from a standard R function
1. added manual page post processing to allow automated tuning of resulting page
1. added manual page statistics - see **computeDocumentStatistics** function manual page
1. enforced capitalization on new section name creation in manual page
1. completed and cleaned up R code - 33 exported functions - 17 internals 
1. completed manual pages - 35 manual pages 
1. enhanced manual pages documentation: review of all contents and corrections
1. completed vignettes - 5 vignettes
1. added data folder to allow for data manual page production and test
1. fixed issues on vignette 
1. completed test panel - 45 test files - 811 tests
1. completed business use cases - 10 BUC
1. Worked on test coverage to reach level higher than 99%
1. **packageFunctionsInformation** verified and upgraded
1. Timing for tests 26s, checks 51s


# Release 1.1.7 - October 2019

Main improvements are 

1. corrected many typographic errors in i/o with end-user
2. completed unit tests
3. enforced higher code coverage (from 75% up to 99.28%)
4. changed many functions visibility from hidden (internal to package) to visible (end-user available).
5. documentation completion
6. clean up package dependencies. 


This release replaces fully olders ones, that are now considered obsoletes. Keep the pace, and 
upgrade your packages if you do not use this version or a higher one!


