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

Add examples and documentation #3

Open
marcelog opened this issue Jan 25, 2018 · 0 comments
Open

Add examples and documentation #3

marcelog opened this issue Jan 25, 2018 · 0 comments

Comments

@marcelog
Copy link
Collaborator

marcelog commented Jan 25, 2018 •
edited
Loading

More examples are needed for:

  1. Explain the structure (supervision trees, workers, what's what and what it does)
  2. Set up a basic use (supervision trees, behaviors, etc). Expose every configuration option and behavior available, explain what it's used for, why it's there, and how it's used exactly.
  3. Explain the different use cases with record examples (KPL, custom KPL, non-KPL)
  4. Explain checkpointing (with and without subrecords)

There is some great doc scattered throughout the sources. These should be exposed in the form of a comprehensive wiki or README so a dev can see upfront what this is all about.
elbrujohalcon pushed a commit that referenced this issue Jul 19, 2018
Avoid cuadratic complexity, keep track of current list length (#3)
00f41e8 
Do not calculate length(List) on each item addition,  keep a track
of the current buffer length.
elbrujohalcon added a commit that referenced this issue Jul 19, 2018
@elbrujohalcon
Fix dialyzer warnings (#10)
25d28e6 
* make the should_deflate flag part of the state (#2)

To control if it should or not deflate,  the library was
accepting a flag on kpl_agg:finish/2.

But, this wasn't applied to aggregated records created implicitly
when adding new items.

This PR makes the should_deflate part of the state, and allow it
to be initialized using kpl_agg:new/1  (default is to not deflate).

Note:
It has a backward incompatible change, as kpl_agg:finish/2 is removed.

* Avoid cuadratic complexity,  keep track of current list length (#3)

Do not calculate length(List) on each item addition,  keep a track
of the current buffer length.

* Remove dialyzer warnings

* Fix #stream_record.timestamp type
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@marcelog