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

Consider using .toml files instead of .md files #30

Closed
not-my-profile opened this issue Nov 26, 2021 · 1 comment · Fixed by #31
Closed

Consider using .toml files instead of .md files #30

not-my-profile opened this issue Nov 26, 2021 · 1 comment · Fixed by #31

Comments

@not-my-profile
Copy link
Contributor

a407f82 split features.toml into many small files ... which of course makes sense maintenance-wise. The data is now however stored in .md files with a TOML frontmatter like

+++
title = "`debug_assert_ne!`"
rfc_id = 1653
impl_pr_id = 35074
tracking_issue_id = 35073
+++

this makes the data harder to work with. If you want to use the data for any other purpose you need to write your own parser for this non-standardized format. It also makes contributing a bit harder ... because it's not immediately clear what format these files have. .toml files are well understood by Rust programmers so I think they really are the natural choice.

@jplatte
Copy link
Owner

jplatte commented Nov 26, 2021

Having frontmatter in markdown files is a common thing and there's really not that much parsing to it. The idea with this was that some features could include an extended description after this frontmatter.

However, I haven't actually gotten around to implementing this and I don't see myself doing it in the near future. I guess it would only apply to some features anyways, so if you want to send a PR switching it back to TOML (if there's ever an extended description, it could also be a multiline string in TOML), I'm okay with merging that.

not-my-profile added a commit to not-my-profile/caniuse.rs that referenced this issue Nov 26, 2021
a407f82 split features.toml into many
.md files with TOML frontmatters. This commit converts all .md files in
the data/ directory to .toml files so that they can be more easily
processed by other software.

Closes jplatte#30.
not-my-profile added a commit to not-my-profile/caniuse.rs that referenced this issue Nov 26, 2021
a407f82 split features.toml into many
.md files with TOML frontmatters. This commit converts all .md files in
the data/ directory to .toml files so that they can be more easily
processed by other software.

Closes jplatte#30.
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 a pull request may close this issue.

2 participants