From e0114b42df08f4070c5c968ea54a6f7c16059ae4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Sat, 21 Dec 2024 10:38:17 +0100 Subject: [PATCH 1/2] changed https links --- docs/extending.md | 2 +- docs/index.md | 8 ++++---- narwhals/stable/v1/__init__.py | 4 ++-- narwhals/translate.py | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/extending.md b/docs/extending.md index 6179fb3ac..2a8953987 100644 --- a/docs/extending.md +++ b/docs/extending.md @@ -27,7 +27,7 @@ The lazy-only layer is a major item on our 2025 roadmap, and hope to be able to the "interchange" level into that one. Libraries for which we have full support can benefit from the whole -[Narwhals API](https://narwhals-dev.github.io/narwhals/api-reference/). +[Narwhals API](./api-reference/index.md). For example: diff --git a/docs/index.md b/docs/index.md index bc0bb39a1..63cdcd5f9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,17 +14,17 @@ Extremely lightweight and extensible compatibility layer between dataframe libra Seamlessly support all, without depending on any! -- ✅ **Just use** [a subset of **the Polars API**](https://narwhals-dev.github.io/narwhals/api-reference/), no need to learn anything new +- ✅ **Just use** [a subset of **the Polars API**](./api-reference/index.md), no need to learn anything new - ✅ **Zero dependencies**, Narwhals only uses what the user passes in so your library can stay lightweight - ✅ Separate **lazy** and eager APIs, use **expressions** - ✅ Support pandas' complicated type system and index, without either getting in the way - ✅ **100% branch coverage**, tested against pandas and Polars nightly builds -- ✅ **Negligible overhead**, see [overhead](https://narwhals-dev.github.io/narwhals/overhead/) -- ✅ Let your IDE help you thanks to **full static typing**, see [typing](https://narwhals-dev.github.io/narwhals/api-reference/typing/) +- ✅ **Negligible overhead**, see [overhead](./overhead.md/) +- ✅ Let your IDE help you thanks to **full static typing**, see [`narwhals.typing`][] - ✅ **Perfect backwards compatibility policy**, - see [stable api](https://narwhals-dev.github.io/narwhals/backcompat/) for how to opt-in + see [stable api](./backcompat.md#perfect-backwards-compatibility-policy) for how to opt-in ## Who's this for? diff --git a/narwhals/stable/v1/__init__.py b/narwhals/stable/v1/__init__.py index 24c0b94c6..4bd0cc1bd 100644 --- a/narwhals/stable/v1/__init__.py +++ b/narwhals/stable/v1/__init__.py @@ -2025,7 +2025,7 @@ def from_native( - `True`: only convert to Narwhals if `native_object` is eager or has interchange-level support in Narwhals - See [interchange-only support](https://narwhals-dev.github.io/narwhals/extending/#interchange-only-support) + See [interchange-only support](../extending.md/#interchange-only-support) for more details. series_only: Whether to only allow Series: @@ -2181,7 +2181,7 @@ def narwhalify( - `True`: only convert to Narwhals if `native_object` is eager or has interchange-level support in Narwhals - See [interchange-only support](https://narwhals-dev.github.io/narwhals/extending/#interchange-only-support) + See [interchange-only support](../extending.md/#interchange-only-support) for more details. series_only: Whether to only allow Series: diff --git a/narwhals/translate.py b/narwhals/translate.py index 2a1f0e435..8542a62f0 100644 --- a/narwhals/translate.py +++ b/narwhals/translate.py @@ -361,7 +361,7 @@ def from_native( - `True`: only convert to Narwhals if `native_object` is eager or has interchange-level support in Narwhals - See [interchange-only support](https://narwhals-dev.github.io/narwhals/extending/#interchange-only-support) + See [interchange-only support](../extending.md/#interchange-only-support) for more details. series_only: Whether to only allow Series: @@ -869,7 +869,7 @@ def narwhalify( - `True`: only convert to Narwhals if `native_object` is eager or has interchange-level support in Narwhals - See [interchange-only support](https://narwhals-dev.github.io/narwhals/extending/#interchange-only-support) + See [interchange-only support](../extending.md/#interchange-only-support) for more details. series_only: Whether to only allow Series: From 5a4dac33fd34c75ee3a577ac927702847d15838e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Sat, 21 Dec 2024 10:52:13 +0100 Subject: [PATCH 2/2] removed extra info in link --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 63cdcd5f9..e6eb13730 100644 --- a/docs/index.md +++ b/docs/index.md @@ -24,7 +24,7 @@ Seamlessly support all, without depending on any! - ✅ **Negligible overhead**, see [overhead](./overhead.md/) - ✅ Let your IDE help you thanks to **full static typing**, see [`narwhals.typing`][] - ✅ **Perfect backwards compatibility policy**, - see [stable api](./backcompat.md#perfect-backwards-compatibility-policy) for how to opt-in + see [stable api](./backcompat.md/) for how to opt-in ## Who's this for?