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

Docstrings in Kedro datasets are pointing to the wrong URLs #527

Closed
stichbury opened this issue Jan 26, 2024 · 0 comments · Fixed by #802, kedro-org/kedro#4069 or kedro-org/kedro-starters#231
Assignees
Labels
bug Something isn't working enhancement New feature or request

Comments

@stichbury
Copy link
Contributor

Description

I'm seeing a lot of instances like this:
image

e.g. https://docs.kedro.org/projects/kedro-datasets/en/kedro-datasets-2.0.0/api/kedro_datasets.pandas.CSVDataset.html#kedro_datasets.pandas.CSVDataset

The link is working (because of redirects) but it's incorrect -- it's https://kedro.readthedocs.io/en/stable/data/data_catalog_yaml_examples.html and it should be https://docs.kedro.org/en/stable/data/data_catalog_yaml_examples.html

(The other docs pages for data catalog are also incorrectly specified, this is just one page example).

A chore task is to fix them all for general link hygiene if nothing else.

I'm pretty sure an engineer can script this change faster than me, so I'm not going to go in with a standard find/replace but suggest it's a Friday afternoon task for a quiet sprint. Low priority.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment