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

Add contribution and installation guides #61

Merged
merged 3 commits into from
May 8, 2024
Merged

Add contribution and installation guides #61

merged 3 commits into from
May 8, 2024

Conversation

wilsonbb
Copy link
Contributor

@wilsonbb wilsonbb commented May 8, 2024

Change Description

Adds installation and contribution guides #46

Note that this still does not update the initial landing page, which we can probably update along with the README

  • My PR includes a link to the issue that I am addressing

Documentation Change Checklist

Copy link

github-actions bot commented May 8, 2024

Before [3d65f46] After [376d883] Ratio Benchmark (Parameter)
8.70±0.4ms 9.47±1ms 1.09 benchmarks.NestedFrameAddNested.time_run
33.1±1ms 34.0±2ms 1.03 benchmarks.AssignSingleDfToNestedSeries.time_run
8.51±0.2ms 8.77±0.3ms 1.03 benchmarks.NestedFrameQuery.time_run
259M 263M 1.02 benchmarks.AssignSingleDfToNestedSeries.peakmem_run
275M 277M 1.01 benchmarks.ReassignHalfOfNestedSeries.peakmem_run
86M 86.1M 1 benchmarks.NestedFrameAddNested.peakmem_run
88.2M 88.4M 1 benchmarks.NestedFrameQuery.peakmem_run
88.2M 88.4M 1 benchmarks.NestedFrameReduce.peakmem_run
5.52±0.1ms 5.28±0.03ms 0.96 benchmarks.NestedFrameReduce.time_run
63.2±3ms 60.4±2ms 0.96 benchmarks.ReassignHalfOfNestedSeries.time_run

Click here to view all benchmarks.

Copy link

codecov bot commented May 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.55%. Comparing base (d299612) to head (c9455d6).

❗ Current head c9455d6 differs from pull request most recent head 1d37325. Consider uploading reports for the commit 1d37325 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #61   +/-   ##
=======================================
  Coverage   97.55%   97.55%           
=======================================
  Files          16       16           
  Lines         818      818           
=======================================
  Hits          798      798           
  Misses         20       20           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wilsonbb wilsonbb requested a review from dougbrn May 8, 2024 18:43
@wilsonbb wilsonbb marked this pull request as ready for review May 8, 2024 18:43
Copy link
Collaborator

@dougbrn dougbrn left a comment

Choose a reason for hiding this comment

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

Looks good! Just one nit

docs/gettingstarted/installation.rst Outdated Show resolved Hide resolved
@wilsonbb wilsonbb merged commit 3d65f46 into main May 8, 2024
7 of 8 checks passed
@wilsonbb wilsonbb deleted the gettingstarted branch May 8, 2024 19:15
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

Successfully merging this pull request may close these issues.

3 participants