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

Fix SnowparkTableDataSet docstrings #152

Merged
merged 1 commit into from
Apr 3, 2023
Merged

Conversation

astrojuanlu
Copy link
Member

Description

See errors at kedro-org/kedro#2485.

Development notes

I tried a docs build locally:

diff --git a/docs/kedro-datasets-docs.sh b/docs/kedro-datasets-docs.sh
index 10054034..aa4bc8f7 100755
--- a/docs/kedro-datasets-docs.sh
+++ b/docs/kedro-datasets-docs.sh
@@ -7,7 +7,7 @@ set -o nounset
 # Exit script if a statement returns a non-true return value.
 set -o errexit
 
-pip install kedro-datasets
-pip install --no-deps -t kedro/to_delete kedro-datasets
+pip install ../kedro-plugins/kedro-datasets
+pip install --no-deps -t kedro/to_delete ../kedro-plugins/kedro-datasets
 mv kedro/to_delete/kedro_datasets kedro/datasets
 rm -r kedro/to_delete

And then make build-docs.

Without the change, it fails:

/home/docs/checkouts/readthedocs.org/user_builds/kedro/checkouts/2485/kedro/datasets/snowflake/snowpark_dataset.py:docstring of kedro.datasets.snowflake.snowpark_dataset.SnowparkTableDataSet:3:Error in "code-block" directive:
maximum 1 argument(s) allowed, 19 supplied.

.. code-block:: yaml
    weather:
      type: kedro_datasets.snowflake.SnowparkTableDataSet
      table_name: "weather_data"
      database: "meteorology"
      schema: "observations"
      credentials: db_credentials
      save_args:
        mode: overwrite
        column_order: name
        table_type: ''

Checklist

  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the relevant RELEASE.md file
  • Added tests to cover my changes

Copy link
Contributor

@noklam noklam left a comment

Choose a reason for hiding this comment

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

Thank you

See kedro-org/kedro#2485.

Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

This is an awesome, amazing set of changes 😜
Thanks 🏆

@astrojuanlu astrojuanlu merged commit dd42e62 into main Apr 3, 2023
@astrojuanlu astrojuanlu deleted the docs/fix-snowpark-docstring branch April 3, 2023 09:09
@astrojuanlu
Copy link
Member Author

Right?? I'm going to add "whitespace" to my list of LinkedIn skills

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