Skip to content

docs: fix broken TOML links in options.md#2726

Open
0xkems wants to merge 1 commit intopypa:mainfrom
0xkems:fix-toml-links-2725
Open

docs: fix broken TOML links in options.md#2726
0xkems wants to merge 1 commit intopypa:mainfrom
0xkems:fix-toml-links-2725

Conversation

@0xkems
Copy link

@0xkems 0xkems commented Feb 2, 2026

Summary

Fixes broken TOML links in docs/options.md where [TOML][] (reference-style link with empty reference) was used instead of a proper link.

Changes

  • Replaced [TOML][] with [TOML](https://toml.io) on lines 621 and 682
  • This matches the style used in docs/configuration.md (line 71)

Testing

The fix is a simple markdown link correction. No code changes.

Fixes #2725

Replace [TOML][] (broken reference-style links) with [TOML](https://toml.io)
(inline links), matching the style used in configuration.md.

Fixes pypa#2725
Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

Hi @0xkems, LGTM, though you may also add a [TOML]: https://toml.io somewhere for reusability. While we're at it, could you please check for more places in this file where "TOML" is referenced, and we can use this link in its place?

@henryiii
Copy link
Contributor

henryiii commented Feb 5, 2026

Agree, adding

[toml]: https://toml.io

is better than adding this to every mention.

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.

[docs][good first issue] Broken TOML links in the options doc

4 participants