riak-core-lite / riak_core_lite

Distributed systems infrastructure used by Riak.
Apache License 2.0
80 stars 13 forks source link

Add specifications and EDoc comments to exported functions #78

Open Tronso opened 3 years ago

Tronso commented 3 years ago

There are many exported functions in riak_core_lite without function specifications or EDoc comments. Some functions are commented on but the comments are missing the edoc tags. According to the edoc documentation it is also preferable to use the standard Erlang -spec specifications instead of the EDoc @spec comments, which can be found in the code.

Checklist of modules to track progress:

Tronso commented 3 years ago

To prevent errors in the specification blocking the master pipeline the issue is handled on branch 78_documentation.