8000 Broken ref in datasets.rst · Issue #29390 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

Broken ref in datasets.rst #29390

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.

Sign up for GitHub

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

Jump to bottom
Closed
jeremiedbb opened this issue Jul 2, 2024 · 2 comments · Fixed by #29405
Closed

Broken ref in datasets.rst #29390

jeremiedbb opened this issue Jul 2, 2024 · 2 comments · Fixed by #29405
Labels
Documentation

Comments

@jeremiedbb
Copy link
Member

There's a reference in datasets.rst that no longer points to anything after #29104 was merged:

scikit-learn/doc/datasets.rst

Lines 9 to 10 in 5bbe346

The ``sklearn.datasets`` package embeds some small toy datasets
as introduced in the :ref:`Getting Started <loading_example_dataset>` section.

I don't understand why it wasn't caught by the CI in #29104. I saw it in the 1.5.1 release branch (#29382), see https://output.circle-artifacts.com/output/job/b0d90a86-a5d1-4ac2-b9b5-c3e6397555da/artifacts/0/doc/_changed.html.

I will ignore it for the release, but we need to rephrase this paragraph because it references a part of the doc that no longer exists.
@lesteve
Copy link
Member
lesteve commented Jul 3, 2024 •
edited
Loading

I don't understand why it wasn't caught by the CI in #29104.

My guess: since we do partial builds in PRs we probably don't turn sphinx warnings into errors?

@jeremiedbb
Copy link
Member Author
jeremiedbb commented Jul 3, 2024 •
edited
Loading

we probably don't turn sphinx warnings into errors?

we do for warnings coming from files that are modified in the PR, that's why circle ci failed in the release branch.
see

scikit-learn/build_tools/circle/build_doc.sh

Lines 248 to 253 in 038bbc1

if [ "$warnings" != "/home/circleci/project/ no warnings" ]
then
echo "Sphinx generated warnings when building the documentation related to files modified in this PR."
echo "Please check doc/_build/html/stable/_changed.html"
exit 1
fi

@jeremiedbb jeremiedbb mentioned this issue Jul 3, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC Rephrase Datasets guide introduction jeremiedbb/scikit-learn
2 participants
@lesteve @jeremiedbb
0