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

docs(patch): Add "About Percentiles" page #221

Merged
merged 2 commits into from
Jan 10, 2024

Conversation

finestructure
Copy link
Contributor

Description

Adds a new documentation page about percentiles and how to interpret them.

How Has This Been Tested?

Generated the docs locally in Xcode.

Minimal checklist:

  • I have performed a self-review of my own code
  • I have added DocC code-level documentation for any public interfaces exported by the package
  • I have added unit and/or integration tests that prove my fix is effective or that my feature works

@finestructure
Copy link
Contributor Author

@hassila , as discussed I've taken a stab at extending the docs with a little more info about percentiles and the like.

I feel like the last section "Interpreting results" could have a little more to it but I struggled to come up with anything other than what I've got. I recall from watching Gil Tene's talks that there should be something about focusing on the worst value but I'm unsure how to phrase that (or even if that's always the best thing to do).

Hope that helps regardless!

@hassila
Copy link
Contributor

hassila commented Jan 10, 2024

This is awesome, thanks @finestructure - much appreciated!

Copy link

codecov bot commented Jan 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2b704b1) 67.18% compared to head (ec59ca7) 67.18%.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #221   +/-   ##
=======================================
  Coverage   67.18%   67.18%           
=======================================
  Files          34       34           
  Lines        4376     4376           
=======================================
  Hits         2940     2940           
  Misses       1436     1436           

Continue to review full report in Codecov by Sentry.

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

@hassila hassila changed the title Add "About Percentiles" page docs(patch): Add "About Percentiles" page Jan 10, 2024
@hassila
Copy link
Contributor

hassila commented Jan 10, 2024

Very nice, thanks again!

@hassila hassila enabled auto-merge (squash) January 10, 2024 15:34
@hassila hassila disabled auto-merge January 10, 2024 15:37
@hassila hassila merged commit 02b4da9 into ordo-one:main Jan 10, 2024
11 of 15 checks passed
@finestructure finestructure deleted the doc-update branch January 10, 2024 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants