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

Create separate documentation for dmod.metrics.Communicator #455

Open
christophertubbs opened this issue Oct 24, 2023 · 0 comments
Open

Create separate documentation for dmod.metrics.Communicator #455

christophertubbs opened this issue Oct 24, 2023 · 0 comments
Assignees
@christophertubbs
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Low Hanging Fruit This should not take a lot of time Low Priority This should not take the place of more important work

Comments

@christophertubbs
Copy link
Contributor

While Communicators are fairly straightforward, there aren't straightforward examples of how to set them up and use them.

Add a separate document, something like communicator.md to link from the README.md that explains how to build and use them.
@christophertubbs christophertubbs added documentation Improvements or additions to documentation good first issue Good for newcomers Low Priority This should not take the place of more important work Low Hanging Fruit This should not take a lot of time labels Oct 24, 2023
@christophertubbs christophertubbs self-assigned this Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@christophertubbs christophertubbs

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Low Hanging Fruit This should not take a lot of time Low Priority This should not take the place of more important work
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@christophertubbs