Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better discoverability of external API #228

Open
Kircheneer opened this issue Apr 26, 2023 · 0 comments
Open

Better discoverability of external API #228

Kircheneer opened this issue Apr 26, 2023 · 0 comments
Labels
status: accepted This issue has been accepted by the maintainers team for implementation type: documentation

Comments

@Kircheneer
Copy link
Collaborator

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 Kircheneer added status: accepted This issue has been accepted by the maintainers team for implementation type: documentation labels Apr 26, 2023
@Kircheneer Kircheneer mentioned this issue Jun 20, 2023
Open
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
status: accepted This issue has been accepted by the maintainers team for implementation type: documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Kircheneer