diffsync icon indicating copy to clipboard operation
diffsync copied to clipboard

Published 20 hours ago • verified publisher icon networktocode

Better discoverability of external API

Open Kircheneer opened this issue 2 years ago • 0 comments

Environment

  • DiffSync version: latest

Proposed Functionality

Add documentation around all public parts of the API. We are already generating documentation for a good amount of things from the docstrings, let's extend that to more parts of the codebase. For example, get_or_instantiate is a valuable feature that is currently only discoverable through the source code.

Use Case

Easier usage.

Kircheneer avatar Apr 26 '23 13:04 Kircheneer