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

Documentation: Add "Extending Deptcharge" manual #17

Open
jynik opened this issue Jul 25, 2020 · 0 comments
Open

Documentation: Add "Extending Deptcharge" manual #17

jynik opened this issue Jul 25, 2020 · 0 comments
Assignees
Labels
documentation Improvements or fixes for documentation

Comments

@jynik
Copy link
Collaborator

jynik commented Jul 25, 2020

I put quite a bit of elbowgrease into ensuring that Depthcharge can be "a tool for quickly building one-off tools". However, the current documentation does not adequately reflect this.

This issue tracker item is to track some ideas and progress on building out a guide on how to extend Depthcharge. I envision this including a good description the Operation.register() functionality, and a solid discussion of some of the class private data members that are leveraged. This also begs the question, which is "really private" vs "intended for use by folks extending Depthcharge at runtime"? -- which is something that should be tackled in a sane manner.

@jynik jynik added the documentation Improvements or fixes for documentation label Jul 25, 2020
@jynik jynik self-assigned this Jul 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or fixes for documentation
Projects
None yet
Development

No branches or pull requests

1 participant