networktocode / diffsync

A utility library for comparing and synchronizing different datasets.
https://diffsync.readthedocs.io/
Other
155 stars 26 forks source link

Better discoverability of external API #228

Open Kircheneer opened 1 year ago

Kircheneer commented 1 year ago

Environment

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.