Description
Related to: #286.
To have any success in documenting the entire public API, we'll likely need to have a small guide for how to document new functions with the use of the KDoc Preprocessor.
The processor is heavily used in sharing some generic concepts across the library, like Selecting Columns or what NA means, having a central place for URLs in docs and, most importantly, it's made it easier to document each and every function in the Columns Selection DSL, as well as providing a DSL grammar for each family of functions.
It also shines when having to rewrite documentation. For instance, when refactoring or changing the name of a function, in many cases, the name only has to be changed once and all DSL grammars containing that function will update automatically.
Finally, I even made it possible to extract KDocs and put them directly on the documentation website, as I did for the Column Selectors docs.
However, as I was making the processor in parallel with actually figuring out how to use it, the bar of entry has become a bit high, so, while the README of the doc preprocessor is a nice way to start, it may help DataFrame and its team more to provide a little guide specific to DataFrame.