From dc0358cf434deda3ede3f8bdce6f21621804e4d4 Mon Sep 17 00:00:00 2001 From: MarcoGorelli <33491632+MarcoGorelli@users.noreply.github.com> Date: Thu, 29 Jun 2023 13:54:35 +0100 Subject: [PATCH 1/2] clarify __dataframe_standard__, introduce __column_standard__ --- protocol/purpose_and_scope.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/protocol/purpose_and_scope.md b/protocol/purpose_and_scope.md index 70dba143..4da6e655 100644 --- a/protocol/purpose_and_scope.md +++ b/protocol/purpose_and_scope.md @@ -76,6 +76,13 @@ def somefunc(df, ...): # From now on, use `df` methods and `namespace` functions/objects ``` +Libraries which implement the Standard in a separate namespace +are required to provide the following methods: +- ``__dataframe_standard__``: used for converting a non-compliant dataframe to a compliant one; +- ``__column_standard__``: used for converting a non-compliant column to a compliant one. + +For example, pandas would have ``pandas.DataFrame.__dataframe_standard__`` and +``pandas.Series.__column_standard__``. ### History From 2a3a964884b56dc3ff7c1e87fc87ab286f95bc69 Mon Sep 17 00:00:00 2001 From: MarcoGorelli <33491632+MarcoGorelli@users.noreply.github.com> Date: Thu, 29 Jun 2023 17:35:15 +0100 Subject: [PATCH 2/2] move to spec --- protocol/purpose_and_scope.md | 8 -------- spec/purpose_and_scope.md | 8 ++++++++ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/protocol/purpose_and_scope.md b/protocol/purpose_and_scope.md index 4da6e655..79c0261b 100644 --- a/protocol/purpose_and_scope.md +++ b/protocol/purpose_and_scope.md @@ -76,14 +76,6 @@ def somefunc(df, ...): # From now on, use `df` methods and `namespace` functions/objects ``` -Libraries which implement the Standard in a separate namespace -are required to provide the following methods: -- ``__dataframe_standard__``: used for converting a non-compliant dataframe to a compliant one; -- ``__column_standard__``: used for converting a non-compliant column to a compliant one. - -For example, pandas would have ``pandas.DataFrame.__dataframe_standard__`` and -``pandas.Series.__column_standard__``. - ### History Dataframe libraries in several programming language exist, such as diff --git a/spec/purpose_and_scope.md b/spec/purpose_and_scope.md index a08025a6..01684752 100644 --- a/spec/purpose_and_scope.md +++ b/spec/purpose_and_scope.md @@ -359,3 +359,11 @@ completed such an implementation may, and are encouraged to, provide details on the level of (non-)conformance. For details on how to do this, see [Verification - measuring conformance](verification_test_suite.md). +Libraries which implement the Standard in a separate namespace +are required to provide the following methods: +- ``__dataframe_standard__``: used for converting a non-compliant dataframe to a compliant one; +- ``__column_standard__``: used for converting a non-compliant column to a compliant one. + +For example, pandas would have ``pandas.DataFrame.__dataframe_standard__`` and +``pandas.Series.__column_standard__``. +