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 broken link in #3121 micropackaging docs #3122

Merged
merged 1 commit into from
Oct 5, 2023

Conversation

stichbury
Copy link
Contributor

NOTE: Kedro datasets are moving from kedro.extras.datasets to a separate kedro-datasets package in
kedro-plugins repository. Any changes to the dataset implementations
should be done by opening a pull request in that repository.

Description

Resolves #3121 by removing offending link.

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

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Oct 5, 2023
@stichbury stichbury self-assigned this Oct 5, 2023
@stichbury stichbury mentioned this pull request Oct 5, 2023
Copy link
Member

@merelcht merelcht left a comment

Choose a reason for hiding this comment

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

👍

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.

LGTM!

@@ -10,7 +10,7 @@ You can package a micro-package by executing: `kedro micropkg package <micropkg_

`kedro micropkg package pipelines.data_processing`

* This will generate a new [source distribution](https://docs.python.org/3/distutils/sourcedist.html) for this micro-package.
* This will generate a new source distribution for this micro-package.
Copy link
Member

Choose a reason for hiding this comment

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

I was about to suggest

Suggested change
* This will generate a new source distribution for this micro-package.
* This will generate a new [source distribution](https://packaging.python.org/en/latest/glossary/#term-Source-Distribution-or-sdist) for this micro-package.

but that page is not only barely useful, but also outdated... ugh

Copy link
Member

Choose a reason for hiding this comment

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

@stichbury stichbury merged commit 2025cfb into main Oct 5, 2023
18 checks passed
@stichbury stichbury deleted the jo-bug-fix-breaking-link branch October 5, 2023 10:45
laizaparizotto pushed a commit to laizaparizotto/kedro that referenced this pull request Oct 9, 2023
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Laiza Parizotto <laizamsparizotto@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken link in docs
3 participants