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.

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

Document the Connection API #374

Open
clintoncwolfe opened this issue Oct 26, 2018 · 1 comment
Open

Document the Connection API #374

clintoncwolfe opened this issue Oct 26, 2018 · 1 comment

Comments

@clintoncwolfe
Copy link
Contributor

Description

As more people are using the Train plugin API, the mystery around the Connection API is creating obstacles to contribution. Let's get a developer doc going, possibly in comments, or in markdown.

By Connection API, I mean BaseConnection, all of its methods, clear understanding of what you must override and what you don't need to, and what you need to add.

This will likely also reveal cruft we may remove.

Train and Platform Version

1.5.0

@clintoncwolfe
Copy link
Contributor Author

Refs #352, #366 , #356

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants