Skip to content

Fix some typos and sphinx warnings in documentation.#932

Merged
benoit-cty merged 2 commits into
mlco2:masterfrom
cianc:docs/typo-fixes
Sep 24, 2025
Merged

Fix some typos and sphinx warnings in documentation.#932
benoit-cty merged 2 commits into
mlco2:masterfrom
cianc:docs/typo-fixes

Conversation

@cianc

@cianc cianc commented Sep 17, 2025

Copy link
Copy Markdown
Contributor

Description

Fixing a few small typos, one broken link, sphinx warnings about too-short underlines, duplicate anchors and incorrent sublist indentation.

Related Issue

Please link to the issue this PR resolves: #935

Motivation and Context

Tidy up.

How Has This Been Tested?

NA

Screenshots (if appropriate):

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

Go over all the following points, and put an x in all the boxes that apply.

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING.md document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@cianc cianc marked this pull request as ready for review September 17, 2025 09:39
A few small typos, sphinx warnings about too-short underlines, duplicate anchors and incorrent sublist indentation.
@benoit-cty

Copy link
Copy Markdown
Contributor

Oh, thank you 🙏 I was too lazy to try to understand all these warnings and fix them.

@benoit-cty benoit-cty merged commit 8d7acf4 into mlco2:master Sep 24, 2025
5 checks passed
@cianc cianc deleted the docs/typo-fixes branch September 24, 2025 20:13
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.

Sphinx emmits many warnings about incorrect markdown when running uv run --only-group doc task docs

2 participants