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

too much documentation #1

Open
dominictarr opened this issue Sep 18, 2012 · 0 comments
Open

too much documentation #1

dominictarr opened this issue Sep 18, 2012 · 0 comments

Comments

@dominictarr
Copy link

Your documentation is much longer than your code.
Is there a simpler way to explain how this works?

It would probably help to see what the clock looks like as json,
initially, then what the concurrent versions look like, and then the merged version.

Also, adding methods like protocol.isConcurrent(a, b).
Would be a lot easier to read than protocol.compare(a, b) == protocol.conts.CONCURRENT
this isn't C.

If I am using this module, do I have to implement the way documents are merged?
It would be good to expand the calendar example to show merging actual data.

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