Project

General

Profile

action #51413

Updated by szarate over 3 years ago

## AC 

 - **AC:** It is ensured, that everyone adding new functionality also documents it 


 ## Tasks 

 1. Create a mechanism that runs [pod-checker](https://metacpan.org/pod/Pod::Checker) pod-checker and shows a list of undocumented functions under /lib 
 2. PR are not able to be merged if the check doesn't pass. 

 ## Suggestions 

 1. Take into account situations where routines/function are so small that don't need documentation, `##nodoc` could be an option to indicate the parser, that the following method doesn't need to be checked. 
 2. Document methods in /lib where it would be useful. 
 3. Figure and propose a podchecker documentation format (and use that script to for the automated checks on travis)

Back