Add a Docstring for all functions in the code and the tests
Justus-at-Tazama opened this issue · comments
As an Tazama Platform Implementer,
I want every function in the platform described with a docstring,
So that I can understand what the function does without reading the documentation somewhere else
Acceptance Criteria
- Cover every custom function in every module of code and test with a docstring.
/**
* @param collection Collection name against which this query will be run
* @param filter String that will put next to the FILTER keyword to run against Arango
*
* ```
* const query = aql`
* FOR doc IN ${collection}
* FILTER ${filter}
* RETURN doc`;
* ```
*
* Note, use "doc." in your query string, as we make use of "doc" as the query and return name.
* @memberof PseudonymsDB
*/
queryPseudonymDB: (collection: string, filter: string, limit?: number) => Promise<any>;
- Find a way to progressively roll out docstrings to every function
Acceptance criteria
- Update the definition of done
- Update the contribution guide
- Fix as we go