From 7a16e1a48a2b1433a39b334787c534569abc4dbe Mon Sep 17 00:00:00 2001 From: Ethan Knights Date: Fri, 30 Aug 2024 11:48:27 +0100 Subject: [PATCH] Cleanup/kedro notebook instructions (#4132) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update add_kedro_to_a_notebook.ipynb Signed-off-by: Ethan Knights * Update add_kedro_to_a_notebook.md Signed-off-by: Ethan Knights * Update README.md Signed-off-by: Ethan Knights * Update RELEASE.md minor language Signed-off-by: Ethan Knights * Update ignore.txt Signed-off-by: Juan Luis Cano Rodríguez --------- Signed-off-by: Ethan Knights Signed-off-by: Juan Luis Cano Rodríguez Co-authored-by: Juan Luis Cano Rodríguez --- .github/styles/Kedro/ignore.txt | 1 + README.md | 4 ++-- RELEASE.md | 2 ++ .../notebook-example/add_kedro_to_a_notebook.ipynb | 2 +- .../notebook-example/add_kedro_to_a_notebook.md | 2 +- 5 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.github/styles/Kedro/ignore.txt b/.github/styles/Kedro/ignore.txt index 76f1165526..9634d1b14b 100644 --- a/.github/styles/Kedro/ignore.txt +++ b/.github/styles/Kedro/ignore.txt @@ -43,3 +43,4 @@ pytest transcoding transcode Claypot +ethanknights diff --git a/README.md b/README.md index 946e5e8378..5cc0bda930 100644 --- a/README.md +++ b/README.md @@ -57,13 +57,13 @@ pip install git+https://github.com/kedro-org/kedro@main | Data Catalog | A series of lightweight data connectors used to save and load data across many different file formats and file systems, including local and network file systems, cloud object stores, and HDFS. The Data Catalog also includes data and model versioning for file-based systems. | | Pipeline Abstraction | Automatic resolution of dependencies between pure Python functions and data pipeline visualisation using [Kedro-Viz](https://github.com/kedro-org/kedro-viz). | | Coding Standards | Test-driven development using [`pytest`](https://github.com/pytest-dev/pytest), produce well-documented code using [Sphinx](http://www.sphinx-doc.org/en/master/), create linted code with support for [`ruff`](https://github.com/astral-sh/ruff) and make use of the standard Python logging library. | -| Flexible Deployment | Deployment strategies that include single or distributed-machine deployment as well as additional support for deploying on Argo, Prefect, Kubeflow, AWS Batch and Databricks. | +| Flexible Deployment | Deployment strategies that include single or distributed-machine deployment as well as additional support for deploying on Argo, Prefect, Kubeflow, AWS Batch, and Databricks. | ## How do I use Kedro? The [Kedro documentation](https://docs.kedro.org/en/stable/) first explains [how to install Kedro](https://docs.kedro.org/en/stable/get_started/install.html) and then introduces [key Kedro concepts](https://docs.kedro.org/en/stable/get_started/kedro_concepts.html). -You can then review the [spaceflights tutorial](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) to build a Kedro project for hands-on experience +You can then review the [spaceflights tutorial](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) to build a Kedro project for hands-on experience. For new and intermediate Kedro users, there's a comprehensive section on [how to visualise Kedro projects using Kedro-Viz](https://docs.kedro.org/en/stable/visualisation/index.html). diff --git a/RELEASE.md b/RELEASE.md index 256ade98d0..7860a8b13c 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -9,9 +9,11 @@ ## Documentation changes * Fix logo on PyPI page. +* Minor language/styling updates. ## Community contributions * [Puneet](https://github.com/puneeter) +* [ethanknights](https://github.com/ethanknights) # Release 0.19.8 diff --git a/docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.ipynb b/docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.ipynb index b5082a7ea7..3c036386cc 100644 --- a/docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.ipynb +++ b/docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.ipynb @@ -36,7 +36,7 @@ "metadata": {}, "source": [ "### The notebook example\n", - "The full example code is given below. To run this, you will need" + "The full example code is given below. To run this, you will need:" ] }, { diff --git a/docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.md b/docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.md index b0c9fe7b58..31b5ba92fe 100644 --- a/docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.md +++ b/docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.md @@ -34,7 +34,7 @@ _Project: You want to construct a model that predicts the price for each trip to ### The notebook example -The full example code is given below. To run this, you will need +The full example code is given below. To run this, you will need: ```python import pandas as pd