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 needed #1

Open
calvertdw opened this issue Nov 9, 2018 · 0 comments
Open

Documentation needed #1

calvertdw opened this issue Nov 9, 2018 · 0 comments

Comments

@calvertdw
Copy link
Member

Would be nice if there was additional explanation in the README to give the rationale behind the various features. I can figure out what they do, but it's hard to know "why" I would use it.

ihmc-rosie pushed a commit that referenced this issue Mar 14, 2019
… to develop

* commit '89926c6831ecf61ce605fe063bb61fd133892a5a':
  Add parameter descriptions.
  Fix spelling error and add 100% Javadoc.
  Fix connection in startMessager to be a blocking call. Add manual tests.
  Add Javadoc.
  Move allowSelfSubmit above isConnected.
  Add a package private default messager update thread to add simpler constructors for KryoMessager.
  Add factory test.
  Convert constructors to static methods with names.
  ⬆️ ihmc-commons to support tools created for this PR, format build.gradle
  Switch to use ihmc-commons ExceptionTools.
  Use ExceptionTools from ihmc-commons.
  Use ihmc-commons Notification class.
  Clean up KryoAdapter so there's never more than one lambda in a line because that's super confusing.
  First working draft of KryoMessager with test.
  Clean up KryoAdapter and get KryoAdapter and KryoDethreadedTest running smoothly.
  Isolated Kryo and Messager tests.
  Line coverage: 80%, Mutation coverage: 53% for SharedMemoryMessager.
  Add MessagerTest and KryoMessager.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant