nedbat / scriv

Changelog management tool
https://scriv.readthedocs.io
Apache License 2.0
256 stars 28 forks source link

toml config examples need quotes #97

Closed DonalChilde closed 1 year ago

DonalChilde commented 1 year ago

I believe the TOML config examples need quotes around the values. ie.

When using a TOML file, the value is specified using periods to separate the sections and key names:

[scriv]
version = literal: pyproject.toml: project.version

needs to be

When using a TOML file, the value is specified using periods to separate the sections and key names:

[scriv]
version = "literal: pyproject.toml: project.version"

At any rate, this is what I had to do to make my pyproject.toml work.

nedbat commented 1 year ago

Thanks. That example is in .ini syntax, showing reading data from a .toml file, so the example is correct, but confusing. In commit 5dafcc5 I've added some more to the page in an attempt to clarify.