Skip to content

gh-156414: Document tomllib's limits & "extensions" - #156415

Merged
encukou merged 2 commits into
python:mainfrom
encukou:toml-docs-clarification
Sep 2, 2026
Merged

gh-156414: Document tomllib's limits & "extensions"#156415
encukou merged 2 commits into
python:mainfrom
encukou:toml-docs-clarification

Conversation

@encukou

@encukou encukou commented Aug 26, 2026

Copy link
Copy Markdown
Member

@read-the-docs-community

read-the-docs-community Bot commented Aug 26, 2026

Copy link
Copy Markdown

Comment thread Doc/library/tomllib.rst Outdated

@hauntsaninja hauntsaninja left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you! This is okay, but I feel like it still is a little "well you can do this if you want to", when I think we should probably want to mildly discourage people relying on ordering of TOML tables (especially given TOML's stance on the matter toml-lang/toml#162)

Comment thread Doc/library/tomllib.rst Outdated
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
@encukou

encukou commented Sep 2, 2026

Copy link
Copy Markdown
Member Author

I think we should probably want to mildly discourage people relying on ordering of TOML tables

There's a bit of nuance here. I definitely want people to not rely on ordering for interop or semantics. But if you generate something based on a TOML config file, you can assume that the output will be reproducible (if you do everything else right).

@encukou encukou changed the title gh-156414: Document tomllib's limits & "extensions" Document tomllib's limits & "extensions" Sep 2, 2026
@encukou encukou changed the title Document tomllib's limits & "extensions" gh-156414: Document tomllib's limits & "extensions" Sep 2, 2026
@encukou
encukou merged commit 3c7e975 into python:main Sep 2, 2026
30 checks passed
@encukou
encukou deleted the toml-docs-clarification branch September 2, 2026 14:00
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Sep 2, 2026
@encukou encukou added awaiting merge needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Sep 2, 2026
@miss-islington-app

Copy link
Copy Markdown

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

@miss-islington-app

Copy link
Copy Markdown

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app

Copy link
Copy Markdown

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖

@bedevere-app

bedevere-app Bot commented Sep 2, 2026

Copy link
Copy Markdown

GH-156833 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Sep 2, 2026
@encukou encukou removed the needs backport to 3.13 bugs and security fixes label Sep 2, 2026
@bedevere-app

bedevere-app Bot commented Sep 2, 2026

Copy link
Copy Markdown

GH-156834 is a backport of this pull request to the 3.13 branch.

@bedevere-app

bedevere-app Bot commented Sep 2, 2026

Copy link
Copy Markdown

GH-156835 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Sep 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting merge docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants