Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise TOML format #2

Merged
merged 1 commit into from
Jan 27, 2024
Merged

Revise TOML format #2

merged 1 commit into from
Jan 27, 2024

Conversation

goerz
Copy link
Member

@goerz goerz commented Jan 27, 2024

Instead of an [Inventory] section, the TOML format now has to start with a comment line that declares the format version. The header fields project and version are now top-level keys.

This looks cleaner, saves a few bytes, and introduces unique "magic bytes" at the beginning of the file so that an inventory.toml file could be recognized as a distinct fromat by FileIO.jl.

Also, version is now optional.

Most previous (experimental) inventory.toml files can still be read without error.

@goerz goerz added the breaking PRs that break compatibility label Jan 27, 2024
Instead of an `[Inventory]` section, the TOML format now has to start
with a comment line that declares the format version. The header fields
`project` and `version` are now top-level keys.

This looks cleaner, saves a few bytes, and introduces unique "magic
bytes" at the beginning of the file so that an `inventory.toml` file
could be recognized as a distinct fromat by FileIO.jl.

Also, `version` is now optional.

Most previous (experimental) `inventory.toml` files can still be read
without error.
@goerz goerz merged commit 828ce32 into master Jan 27, 2024
8 checks passed
@goerz goerz deleted the new-toml-header branch January 27, 2024 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking PRs that break compatibility
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant