UrbanCCD-UChicago / plenario2

The Premier Open Data Discovery Platform
http://plenar.io/
Other
12 stars 2 forks source link

421 Document API Helper Funcs #423

Closed vforgione closed 6 years ago

vforgione commented 6 years ago

Cleaned and Documented API View Utils

I added docs and specs to the public functions and updated the private is_clean function to be built at compile time using lists of keys and values to define dirty types. The beauty of this is that we can just keep updating those lists as needed without having to touch the functions.

Added Docs to Controller Utils and Renamed a Function

Let's start with the rename -- validate_data_set was a really awful choice for what the function took as a parameter and what it returned. The new name, validate_slug_get_meta tells you exactly what it does.

I also added docs for all public functions.

Added Docs to API Plugs

Closes #421