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

Examples to T-Digest functions #39

Merged
merged 4 commits into from
Jun 14, 2021
Merged

Conversation

AvitalFineRedis
Copy link
Contributor

No description provided.

@AvitalFineRedis AvitalFineRedis changed the title example Examples to T-Digest functions Jun 9, 2021
@AvitalFineRedis AvitalFineRedis linked an issue Jun 9, 2021 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Jun 9, 2021

Codecov Report

Merging #39 (9892d52) into master (dfef579) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #39   +/-   ##
=======================================
  Coverage   87.50%   87.50%           
=======================================
  Files           2        2           
  Lines         328      328           
=======================================
  Hits          287      287           
  Misses         23       23           
  Partials       18       18           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dfef579...9892d52. Read the comment docs.

@filipecosta90 filipecosta90 added the documentation Improvements or additions to documentation label Jun 10, 2021
Copy link
Collaborator

@filipecosta90 filipecosta90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AvitalFineRedis we need to do some tweaks for it to work

If you run:

godoc -http :6060

Notice:

  • you will see that the examples don't show up given we need the name to be changed from for example: ExampleTdCreate to ExampleClient_TdCreate given the functions are for the client struct.
  • another thing is that we mixed 3 examples in one ( min, max, tdcdf ) I would split them into separate ones given we want them to be showcased on each method.
  • Notice that TdCdf() example should be improved given we use it to calculate cumulative distributions ( so a cumulative dist of 0 is for sure the min... ). Let's target something in the middle.
  • we also need an example for TdQuantile().

Copy link
Collaborator

@filipecosta90 filipecosta90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small typo on the comment. apart from it we're good to go. LVGTM

Co-authored-by: filipe oliveira <filipecosta.90@gmail.com>
@sonarcloud
Copy link

sonarcloud bot commented Jun 13, 2021

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 8 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Collaborator

@filipecosta90 filipecosta90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AvitalFineRedis AvitalFineRedis merged commit 4df8630 into master Jun 14, 2021
@AvitalFineRedis AvitalFineRedis deleted the add_T-Digest-example branch June 14, 2021 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

T-Digest creation, ingestion, and querying command examples
2 participants