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

Mention upcoming removal and rename of datasets in docs + release notes #3155

Merged
merged 4 commits into from
Oct 11, 2023

Conversation

merelcht
Copy link
Member

@merelcht merelcht commented Oct 10, 2023

Description

Part of #2129

Development notes

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • 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 RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

@merelcht merelcht self-assigned this Oct 10, 2023
@merelcht merelcht requested review from deepyaman and removed request for astrojuanlu and yetudada October 10, 2023 15:41
RELEASE.md Outdated Show resolved Hide resolved
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.

Made a suggested change the boilerplate warning for each of the data catalog docs file (but I only applied the suggestion to the first occurrence).

@merelcht
Copy link
Member Author

Made a suggested change the boilerplate warning for each of the data catalog docs file (but I only applied the suggestion to the first occurrence).

Thanks Jo, I've updated this now across all files.

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.

Awesome, thanks for this 💯

Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

👍🏽 with a nitpick

@@ -20,6 +20,9 @@
* Added documentation to clarify execution order of hooks.
## Breaking changes to the API
## Upcoming deprecations for Kedro 0.19.0
* All dataset classes will be removed from the core Kedro repository (`kedro.extras.datasets`). Install and import them from the [`kedro-datasets`](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-datasets) package instead.
Copy link
Member

Choose a reason for hiding this comment

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

Was this a new deprecation? This was already noted in 0.18.8 (see this same document, far below)

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah I missed that.. so technically it's not new, but in 0.18.8 it fell under documentation, and I also feel that this is probably significant enough to mention again. WDYT?

Copy link
Member

Choose a reason for hiding this comment

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

Doesn't hurt to emphasize it there again! 👍🏽

@@ -20,6 +20,9 @@
* Added documentation to clarify execution order of hooks.
## Breaking changes to the API
## Upcoming deprecations for Kedro 0.19.0
* All dataset classes will be removed from the core Kedro repository (`kedro.extras.datasets`). Install and import them from the [`kedro-datasets`](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-datasets) package instead.
* All dataset classes ending with `DataSet` are deprecated and will be removed in Kedro `0.19.0` and `kedro-datasets` `2.0.0`. Instead, use the updated class names ending with `Dataset`.
Copy link
Member

Choose a reason for hiding this comment

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

👍🏽

@merelcht merelcht merged commit fac8858 into main Oct 11, 2023
33 of 41 checks passed
@merelcht merelcht deleted the add-message-about-datasets-move-and-rename branch October 11, 2023 14:18
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