aai-institute/lakefs-spec

Improve public API docs coverage

Closed this issue · 1 comments

AdrianoKF commented

In order to make the generated API docs (more) useful, the code should include docstrings for (at a minimum):

  • All modules: otherwise, subpages in the API reference will appear empty (since the are generated from the module docstring)
  • All public members (function, classes): e.g., the config module is entire undocumented
  • Any missing type annotations
AdrianoKF commented

Closed by #168, #181, #184