Skip to content

Fix Documentation - Separate the subsections in the Tutorial - #683

Merged
magdalenafuentes merged 2 commits into
mir-dataset-loaders:masterfrom
SidSaxena01:fix/documentation
Jul 31, 2025
Merged

Fix Documentation - Separate the subsections in the Tutorial#683
magdalenafuentes merged 2 commits into
mir-dataset-loaders:masterfrom
SidSaxena01:fix/documentation

Conversation

@SidSaxena01

@SidSaxena01 SidSaxena01 commented Jul 24, 2025

Copy link
Copy Markdown
Collaborator

This pull request makes a small documentation update to the docs/source/tutorial.rst file.
Previously, all the subsections were under the "Installation" subsection rather than their own separate subsections.
It has now been fixed to have separate subsections as expected.

image

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes the documentation structure in the tutorial by correcting the RestructuredText heading hierarchy. Previously, all subsections were incorrectly nested under the "Installation" section instead of being separate top-level subsections.

  • Adds proper spacing to separate the "Installation" subsection from the main "Tutorial" heading
  • Ensures subsections appear as independent sections rather than nested under "Installation"

@codecov

codecov Bot commented Jul 24, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.04%. Comparing base (f61932d) to head (708a970).
⚠️ Report is 15 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #683   +/-   ##
=======================================
  Coverage   97.04%   97.04%           
=======================================
  Files          68       68           
  Lines        7354     7354           
=======================================
  Hits         7137     7137           
  Misses        217      217           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@magdalenafuentes
magdalenafuentes merged commit f4b3f4b into mir-dataset-loaders:master Jul 31, 2025
12 checks passed
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.

4 participants