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

Small changes of the docs #15

Merged
merged 3 commits into from
May 30, 2024
Merged

Small changes of the docs #15

merged 3 commits into from
May 30, 2024

Conversation

hombit
Copy link
Collaborator

@hombit hombit commented May 23, 2024

Change Description

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

Solution Description

Code Quality

  • I have read the Contribution Guide
  • My code follows the code style of this project
  • My code builds (or compiles) cleanly without any errors or warnings
  • My code contains relevant comments and necessary documentation

Project-Specific Pull Request Checklists

Bug Fix Checklist

  • My fix includes a new test that breaks as a result of the bug (if possible)
  • My change includes a breaking change
    • My change includes backwards compatibility and deprecation warnings (if possible)

New Feature Checklist

  • I have added or updated the docstrings associated with my feature using the NumPy docstring format
  • I have updated the tutorial to highlight my new feature (if appropriate)
  • I have added unit/End-to-End (E2E) test cases to cover my new feature
  • My change includes a breaking change
    • My change includes backwards compatibility and deprecation warnings (if possible)

Documentation Change Checklist

Build/CI Change Checklist

  • If required or optional dependencies have changed (including version numbers), I have updated the README to reflect this
  • If this is a new CI setup, I have added the associated badge to the README

Other Change Checklist

  • Any new or updated docstrings use the NumPy docstring format.
  • I have updated the tutorial to highlight my new feature (if appropriate)
  • I have added unit/End-to-End (E2E) test cases to cover any changes
  • My change includes a breaking change
    • My change includes backwards compatibility and deprecation warnings (if possible)

@hombit hombit requested a review from dougbrn May 23, 2024 18:47
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link

github-actions bot commented May 23, 2024

Before [7ffa702] After [3aef2b1] Ratio Benchmark (Parameter)
232±2ms 234±2ms 1.01 benchmarks.NestedFrameAddNested.time_run
149M 148M 1 benchmarks.NestedFrameAddNested.peakmem_run
150M 150M 1 benchmarks.NestedFrameQuery.peakmem_run
148M 147M 1 benchmarks.NestedFrameReduce.peakmem_run
491±2ms 486±0.5ms 0.99 benchmarks.NestedFrameQuery.time_run
375±2ms 373±2ms 0.99 benchmarks.NestedFrameReduce.time_run

Click here to view all benchmarks.

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, thank you!

@hombit hombit merged commit dac5188 into main May 30, 2024
15 checks passed
@hombit hombit deleted the docs-fixes branch May 30, 2024 17:12
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.

2 participants