Issue 3/improve readme #9
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Need to refactor and also add new methods to other factories.
Created static factory methods for the rest clients. Moved to different package (but shouldn't effect anything outside of this project...)
adding more javadoc to ClusterService
Deprecating the old constructors
Adding javadocs to service objects. Still have 2 more to go. Adding example to readme
…oint. Can add even more later.
javamonkey79
approved these changes
Sep 19, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Will be a first pass at resolving #3
The README.md needs even more work, especially more examples. But I think that the javadocs on our services will actually be the best documentation. I made sure that all services now have links to the specific db endpoints used.
In terms of examples, I am guessing we will want to get to a point where every service has a concrete example. This might be most easily done by referring to our test code.
Note this branch was actually branched off of issue-1, so issue-1 should be merged first.