From d19b8e5fa746483f429204427dfea41470ed7f7c Mon Sep 17 00:00:00 2001 From: Doug Branton Date: Thu, 16 May 2024 11:49:57 -0700 Subject: [PATCH] doc tweaks --- README.md | 15 ++++++++------- docs/gettingstarted/quickstart.ipynb | 2 +- docs/index.rst | 2 +- src/nested_pandas/nestedframe/core.py | 2 +- 4 files changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8fbc77e..f4a7bca 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ # nested-pandas + +[![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/) + +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/lincc-frameworks/nested-pandas/smoke-test.yml)](https://github.com/lincc-frameworks/nested-pandas/actions/workflows/smoke-test.yml) +[![codecov](https://codecov.io/gh/lincc-frameworks/nested-pandas/branch/main/graph/badge.svg)](https://codecov.io/gh/lincc-frameworks/nested-pandas) +[![Read the Docs](https://img.shields.io/readthedocs/nested-pandas)](https://nested-pandas.readthedocs.io/) +[![benchmarks](https://img.shields.io/github/actions/workflow/status/lincc-frameworks/nested-pandas/asv-main.yml?label=benchmarks)](https://lincc-frameworks.github.io/nested-pandas/) + An extension of pandas for efficient representation of nested associated datasets. @@ -25,13 +33,6 @@ This is a LINCC Frameworks project - find more information about LINCC Framework -[![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/) - -[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/lincc-frameworks/nested-pandas/smoke-test.yml)](https://github.com/lincc-frameworks/nested-pandas/actions/workflows/smoke-test.yml) -[![codecov](https://codecov.io/gh/lincc-frameworks/nested-pandas/branch/main/graph/badge.svg)](https://codecov.io/gh/lincc-frameworks/nested-pandas) -[![Read the Docs](https://img.shields.io/readthedocs/nested-pandas)](https://nested-pandas.readthedocs.io/) -[![benchmarks](https://img.shields.io/github/actions/workflow/status/lincc-frameworks/nested-pandas/asv-main.yml?label=benchmarks)](https://lincc-frameworks.github.io/nested-pandas/) - ## Acknowledgements This project is supported by Schmidt Sciences. diff --git a/docs/gettingstarted/quickstart.ipynb b/docs/gettingstarted/quickstart.ipynb index 8f938d8..6d7355e 100644 --- a/docs/gettingstarted/quickstart.ipynb +++ b/docs/gettingstarted/quickstart.ipynb @@ -90,7 +90,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "nested-pandas extends the Pandas API, meaning any operation you could do in Pandas is available within nested-pandas. However, nested-pandas has additional functionality and tooling to better support working with Nested datasets. For example, let's look at `query`:" + "nested-pandas extends the Pandas API, meaning any operation you could do in Pandas is available within nested-pandas. However, nested-pandas has additional functionality and tooling to better support working with nested datasets. For example, let's look at `query`:" ] }, { diff --git a/docs/index.rst b/docs/index.rst index 697e1ef..0bc5cd9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -51,5 +51,5 @@ Learn more about contributing to this repository in our :doc:`Contribution Guide Home page Getting Started - Notebooks + Tutorials API Reference diff --git a/src/nested_pandas/nestedframe/core.py b/src/nested_pandas/nestedframe/core.py index 71dd33f..18c36a9 100644 --- a/src/nested_pandas/nestedframe/core.py +++ b/src/nested_pandas/nestedframe/core.py @@ -345,7 +345,7 @@ def dropna( ) return new_df - def reduce(self, func, *args, **kwargs) -> NestedFrame: + def reduce(self, func, *args, **kwargs) -> NestedFrame: # type: ignore[override] """ Takes a function and applies it to each top-level row of the NestedFrame.