docs: use parse API in the README example - #79
Merged
RonnyPfannschmidt merged 1 commit intoOct 6, 2026
Merged
Conversation
MbappeWU
marked this pull request as ready for review
October 5, 2026 20:43
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README constructs
IniConfig()but shows values with inline comments removed. The constructor deliberately preserves those comments for compatibility, so the first displayed result is currently incorrect.Use the
IniConfig.parse()API introduced in #70, and explain how the constructor andstrip_inline_comments=Falsepreserve comments. This updates the documented example without changing parser behavior.Validation on Python 3.13.12 with the original frozen development dependencies:
value1expected;value1 # commentreturned).py.typedcontent match source.git diff --check: passed.The generated version module has the same version as package metadata; its commit ID is absent in the wheel built from the sdist, as expected without Git metadata. These are local validation distributions, not a release.
AI assistance: prepared with OpenAI Codex and checked by a separate AI review. No human review is claimed by those checks.